com.amazonaws.services.iot.model

Class ListJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.ListJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListJobsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListJobsRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListJobsRequest

public ListJobsRequest()

Method Detail

setStatus

public void setStatus(String status)

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

Parameters:

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

See Also:

JobStatus

getStatus

public String getStatus()

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

Returns:

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

See Also:

JobStatus

withStatus

public ListJobsRequest withStatus(String status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus

withStatus

public ListJobsRequest withStatus(JobStatus status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobStatus

setTargetSelection

public void setTargetSelection(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.

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.

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.

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

getTargetSelection

public 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.

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.

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

withTargetSelection

public ListJobsRequest withTargetSelection(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.

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.

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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

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.

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.

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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetSelection

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return per request.

Parameters:

maxResults - The maximum number of results to return per request.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return per request.

Returns:

The maximum number of results to return per request.

withMaxResults

public ListJobsRequest withMaxResults(Integer maxResults)

The maximum number of results to return per request.

Parameters:

maxResults - The maximum number of results to return per request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

The token to retrieve the next set of results.

Parameters:

nextToken - The token to retrieve the next set of results.

getNextToken

public String getNextToken()

The token to retrieve the next set of results.

Returns:

The token to retrieve the next set of results.

withNextToken

public ListJobsRequest withNextToken(String nextToken)

The token to retrieve the next set of results.

Parameters:

nextToken - The token to retrieve the next set of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

setThingGroupName

public void setThingGroupName(String thingGroupName)

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

Parameters:

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

getThingGroupName

public String getThingGroupName()

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.

withThingGroupName

public ListJobsRequest withThingGroupName(String thingGroupName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setThingGroupId

public void setThingGroupId(String thingGroupId)

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

Parameters:

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

getThingGroupId

public String getThingGroupId()

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.

withThingGroupId

public ListJobsRequest withThingGroupId(String thingGroupId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNamespaceId

public void setNamespaceId(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.

Parameters:

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.

getNamespaceId

public String getNamespaceId()

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.

withNamespaceId

public ListJobsRequest withNamespaceId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListJobsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()