software.amazon.awssdk.services.iot.model

Class ListJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.ListJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListJobsRequest
extends IotRequest
implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListJobsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListJobsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of results to return per request.
String	namespaceId() The namespace used to indicate that a job is a customer-managed job.
String	nextToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListJobsRequest.Builder>	serializableBuilderClass()
JobStatus	status() An optional filter that lets you search for jobs that have the specified status.
String	statusAsString() An optional filter that lets you search for jobs that have the specified status.
TargetSelection	targetSelection() Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).
String	targetSelectionAsString() Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).
String	thingGroupId() A filter that limits the returned jobs to those for the specified group.
String	thingGroupName() A filter that limits the returned jobs to those for the specified group.
ListJobsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

status

public final JobStatus status()

An optional filter that lets you search for jobs that have the specified status.

If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

An optional filter that lets you search for jobs that have the specified status.

See Also:

JobStatus

statusAsString

public final String statusAsString()

An optional filter that lets you search for jobs that have the specified status.

If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

An optional filter that lets you search for jobs that have the specified status.

See Also:

JobStatus

targetSelection

public final TargetSelection targetSelection()

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().

Returns:

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

See Also:

TargetSelection

targetSelectionAsString

public final String targetSelectionAsString()

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().

Returns:

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

See Also:

TargetSelection

maxResults

public final Integer maxResults()

The maximum number of results to return per request.

Returns:

The maximum number of results to return per request.

nextToken

public final String nextToken()

The token to retrieve the next set of results.

Returns:

The token to retrieve the next set of results.

thingGroupName

public final String thingGroupName()

A filter that limits the returned jobs to those for the specified group.

Returns:

A filter that limits the returned jobs to those for the specified group.

thingGroupId

public final String thingGroupId()

A filter that limits the returned jobs to those for the specified group.

Returns:

A filter that limits the returned jobs to those for the specified group.

namespaceId

public final String namespaceId()

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Returns:

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

toBuilder

public ListJobsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static ListJobsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListJobsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.