ListJobsRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.ListJobsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ListJobsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Lists jobs.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListJobsRequest()

Constructors
Constructor and Description
`ListJobsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getMaxResults()` The maximum number of results to return per request.
`java.lang.String`	`getNamespaceId()` The namespace used to indicate that a job is a customer-managed job.
`java.lang.String`	`getNextToken()` The token to retrieve the next set of results.
`java.lang.String`	`getStatus()` An optional filter that lets you search for jobs that have the specified status.
`java.lang.String`	`getTargetSelection()` 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).
`java.lang.String`	`getThingGroupId()` A filter that limits the returned jobs to those for the specified group.
`java.lang.String`	`getThingGroupName()` A filter that limits the returned jobs to those for the specified group.
`int`	`hashCode()`
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per request.
`void`	`setNamespaceId(java.lang.String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`void`	`setNextToken(java.lang.String nextToken)` The token to retrieve the next set of results.
`void`	`setStatus(JobStatus status)` An optional filter that lets you search for jobs that have the specified status.
`void`	`setStatus(java.lang.String status)` An optional filter that lets you search for jobs that have the specified status.
`void`	`setTargetSelection(java.lang.String 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).
`void`	`setTargetSelection(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).
`void`	`setThingGroupId(java.lang.String thingGroupId)` A filter that limits the returned jobs to those for the specified group.
`void`	`setThingGroupName(java.lang.String thingGroupName)` A filter that limits the returned jobs to those for the specified group.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListJobsRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per request.
`ListJobsRequest`	`withNamespaceId(java.lang.String namespaceId)` The namespace used to indicate that a job is a customer-managed job.
`ListJobsRequest`	`withNextToken(java.lang.String nextToken)` The token to retrieve the next set of results.
`ListJobsRequest`	`withStatus(JobStatus status)` An optional filter that lets you search for jobs that have the specified status.
`ListJobsRequest`	`withStatus(java.lang.String status)` An optional filter that lets you search for jobs that have the specified status.
`ListJobsRequest`	`withTargetSelection(java.lang.String 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).
`ListJobsRequest`	`withTargetSelection(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).
`ListJobsRequest`	`withThingGroupId(java.lang.String thingGroupId)` A filter that limits the returned jobs to those for the specified group.
`ListJobsRequest`	`withThingGroupName(java.lang.String thingGroupName)` A filter that limits the returned jobs to those for the specified group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListJobsRequest
```
public ListJobsRequest()
```
- Method Detail
  - getStatus
```
public java.lang.String getStatus()
```
    An optional filter that lets you search for jobs that have the specified status.
    
    Constraints:
    Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
    
    Returns:
    
    An optional filter that lets you search for jobs that have the specified status.
    
    See Also:
    
    JobStatus
  - setStatus
```
public void setStatus(java.lang.String status)
```
    An optional filter that lets you search for jobs that have the specified status.
    
    Constraints:
    Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
    
    Parameters:
    
    status -
    An optional filter that lets you search for jobs that have the specified status.
    
    See Also:
    
    JobStatus
  - withStatus
```
public ListJobsRequest withStatus(java.lang.String status)
```
    An optional filter that lets you search for jobs that have the specified status.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
    
    Parameters:
    
    status -
    An optional filter that lets you search for jobs that have the specified status.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setStatus
```
public void setStatus(JobStatus status)
```
    An optional filter that lets you search for jobs that have the specified status.
    
    Constraints:
    Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
    
    Parameters:
    
    status -
    An optional filter that lets you search for jobs that have the specified status.
    
    See Also:
    
    JobStatus
  - withStatus
```
public ListJobsRequest withStatus(JobStatus status)
```
    An optional filter that lets you search for jobs that have the specified status.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: IN_PROGRESS, CANCELED, COMPLETED, DELETION_IN_PROGRESS
    
    Parameters:
    
    status -
    An optional filter that lets you search for jobs that have the specified status.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - getTargetSelection
```
public java.lang.String getTargetSelection()
```
    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.
    
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    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
  - setTargetSelection
```
public void setTargetSelection(java.lang.String 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.
    
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    Parameters:
    
    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.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
public ListJobsRequest withTargetSelection(java.lang.String 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - setTargetSelection
```
public void setTargetSelection(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.
    
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    Parameters:
    
    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.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
public ListJobsRequest withTargetSelection(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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CONTINUOUS, SNAPSHOT
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of results to return per request.
    
    Constraints:
    Range: 1 - 250
    
    Returns:
    
    The maximum number of results to return per request.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per request.
    
    Constraints:
    Range: 1 - 250
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per request.
  - withMaxResults
```
public ListJobsRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per request.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 250
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per request.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    The token to retrieve the next set of results.
    
    Returns:
    
    The token to retrieve the next set of results.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The token to retrieve the next set of results.
    
    Parameters:
    
    nextToken -
    The token to retrieve the next set of results.
  - withNextToken
```
public ListJobsRequest withNextToken(java.lang.String nextToken)
```
    The token to retrieve the next set of results.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    nextToken -
    The token to retrieve the next set of results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getThingGroupName
```
public java.lang.String getThingGroupName()
```
    A filter that limits the returned jobs to those for the specified group.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Returns:
    
    A filter that limits the returned jobs to those for the specified group.
  - setThingGroupName
```
public void setThingGroupName(java.lang.String thingGroupName)
```
    A filter that limits the returned jobs to those for the specified group.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    thingGroupName -
    A filter that limits the returned jobs to those for the specified group.
  - withThingGroupName
```
public ListJobsRequest withThingGroupName(java.lang.String thingGroupName)
```
    A filter that limits the returned jobs to those for the specified group.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    thingGroupName -
    A filter that limits the returned jobs to those for the specified group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getThingGroupId
```
public java.lang.String getThingGroupId()
```
    A filter that limits the returned jobs to those for the specified group.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9\-]+
    
    Returns:
    
    A filter that limits the returned jobs to those for the specified group.
  - setThingGroupId
```
public void setThingGroupId(java.lang.String thingGroupId)
```
    A filter that limits the returned jobs to those for the specified group.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9\-]+
    
    Parameters:
    
    thingGroupId -
    A filter that limits the returned jobs to those for the specified group.
  - withThingGroupId
```
public ListJobsRequest withThingGroupId(java.lang.String thingGroupId)
```
    A filter that limits the returned jobs to those for the specified group.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9\-]+
    
    Parameters:
    
    thingGroupId -
    A filter that limits the returned jobs to those for the specified group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNamespaceId
```
public java.lang.String getNamespaceId()
```
    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.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    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.
  - setNamespaceId
```
public void setNamespaceId(java.lang.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.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    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.
  - withNamespaceId
```
public ListJobsRequest withNamespaceId(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ListJobsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListJobsRequest

Method Detail

getStatus

setStatus

withStatus

setStatus

withStatus

getTargetSelection

setTargetSelection

withTargetSelection

setTargetSelection

withTargetSelection

getMaxResults

setMaxResults

withMaxResults

getNextToken

setNextToken

withNextToken

getThingGroupName

setThingGroupName

withThingGroupName

getThingGroupId

setThingGroupId

withThingGroupId

getNamespaceId

setNamespaceId

withNamespaceId

toString

hashCode

equals