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("software.amazon.awssdk:codegen")
public final class ListJobsRequest
extends IotRequest
implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListJobsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListJobsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()`
`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
clone, finalize, 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.
    
    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
    
    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.
    
    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
    
    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.
    
    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
    
    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.
    
    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
    
    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, Amazon Web Services 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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
    
    Returns:
    
    The namespace used to indicate that a job is a customer-managed job.
    
    When you specify a value for this parameter, Amazon Web Services 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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
  - toBuilder
```
public ListJobsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListJobsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

status

statusAsString

targetSelection

targetSelectionAsString

maxResults

nextToken

thingGroupName

thingGroupId

namespaceId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields