com.amazonaws.services.iot.model

Class CreateJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateJobRequest
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
CreateJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A short text description of the job.
String	getDocument() The job document.
String	getDocumentSource() An S3 link to the job document.
JobExecutionsRolloutConfig	getJobExecutionsRolloutConfig() Allows you to create a staged rollout of the job.
String	getJobId() A job identifier which must be unique for your AWS account.
PresignedUrlConfig	getPresignedUrlConfig() Configuration information for pre-signed S3 URLs.
List<String>	getTargets() A list of things and thing groups to which the job should be sent.
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).
int	hashCode()
void	setDescription(String description) A short text description of the job.
void	setDocument(String document) The job document.
void	setDocumentSource(String documentSource) An S3 link to the job document.
void	setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig) Allows you to create a staged rollout of the job.
void	setJobId(String jobId) A job identifier which must be unique for your AWS account.
void	setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig) Configuration information for pre-signed S3 URLs.
void	setTargets(Collection<String> targets) A list of things and thing groups to which the job should be sent.
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).
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateJobRequest	withDescription(String description) A short text description of the job.
CreateJobRequest	withDocument(String document) The job document.
CreateJobRequest	withDocumentSource(String documentSource) An S3 link to the job document.
CreateJobRequest	withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig) Allows you to create a staged rollout of the job.
CreateJobRequest	withJobId(String jobId) A job identifier which must be unique for your AWS account.
CreateJobRequest	withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig) Configuration information for pre-signed S3 URLs.
CreateJobRequest	withTargets(Collection<String> targets) A list of things and thing groups to which the job should be sent.
CreateJobRequest	withTargets(String... targets) A list of things and thing groups to which the job should be sent.
CreateJobRequest	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).
CreateJobRequest	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).

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

CreateJobRequest

public CreateJobRequest()

Method Detail

setJobId

public void setJobId(String jobId)

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Parameters:

jobId - A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

getJobId

public String getJobId()

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Returns:

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

withJobId

public CreateJobRequest withJobId(String jobId)

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Parameters:

jobId - A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Returns:

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

getTargets

public List<String> getTargets()

A list of things and thing groups to which the job should be sent.

Returns:

A list of things and thing groups to which the job should be sent.

setTargets

public void setTargets(Collection<String> targets)

A list of things and thing groups to which the job should be sent.

Parameters:

targets - A list of things and thing groups to which the job should be sent.

withTargets

public CreateJobRequest withTargets(String... targets)

A list of things and thing groups to which the job should be sent.

NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.

Parameters:

targets - A list of things and thing groups to which the job should be sent.

Returns:

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

withTargets

public CreateJobRequest withTargets(Collection<String> targets)

A list of things and thing groups to which the job should be sent.

Parameters:

targets - A list of things and thing groups to which the job should be sent.

Returns:

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

setDocumentSource

public void setDocumentSource(String documentSource)

An S3 link to the job document.

Parameters:

documentSource - An S3 link to the job document.

getDocumentSource

public String getDocumentSource()

An S3 link to the job document.

Returns:

An S3 link to the job document.

withDocumentSource

public CreateJobRequest withDocumentSource(String documentSource)

An S3 link to the job document.

Parameters:

documentSource - An S3 link to the job document.

Returns:

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

setDocument

public void setDocument(String document)

The job document.

Parameters:

document - The job document.

getDocument

public String getDocument()

The job document.

Returns:

The job document.

withDocument

public CreateJobRequest withDocument(String document)

The job document.

Parameters:

document - The job document.

Returns:

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

setDescription

public void setDescription(String description)

A short text description of the job.

Parameters:

description - A short text description of the job.

getDescription

public String getDescription()

A short text description of the job.

Returns:

A short text description of the job.

withDescription

public CreateJobRequest withDescription(String description)

A short text description of the job.

Parameters:

description - A short text description of the job.

Returns:

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

setPresignedUrlConfig

public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Configuration information for pre-signed S3 URLs.

Parameters:

presignedUrlConfig - Configuration information for pre-signed S3 URLs.

getPresignedUrlConfig

public PresignedUrlConfig getPresignedUrlConfig()

Configuration information for pre-signed S3 URLs.

Returns:

Configuration information for pre-signed S3 URLs.

withPresignedUrlConfig

public CreateJobRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Configuration information for pre-signed S3 URLs.

Parameters:

presignedUrlConfig - Configuration information for pre-signed S3 URLs.

Returns:

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

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.

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

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.

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

withTargetSelection

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

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:

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

See Also:

TargetSelection

withTargetSelection

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

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:

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

See Also:

TargetSelection

setJobExecutionsRolloutConfig

public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Allows you to create a staged rollout of the job.

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.

getJobExecutionsRolloutConfig

public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()

Allows you to create a staged rollout of the job.

Returns:

Allows you to create a staged rollout of the job.

withJobExecutionsRolloutConfig

public CreateJobRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Allows you to create a staged rollout of the job.

Parameters:

jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.

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; useful for testing and debugging.

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 CreateJobRequest 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()