com.amazonaws.services.iot.model

Class CreateJobTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateJobTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateJobTemplateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AbortConfig	getAbortConfig()
String	getDescription() A description of the job document.
List<String>	getDestinationPackageVersions() The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
String	getDocument() The job document.
String	getDocumentSource() An S3 link, or S3 object URL, to the job document.
String	getJobArn() The ARN of the job to use as the basis for the job template.
JobExecutionsRetryConfig	getJobExecutionsRetryConfig() Allows you to create the criteria to retry a job.
JobExecutionsRolloutConfig	getJobExecutionsRolloutConfig()
String	getJobTemplateId() A unique identifier for the job template.
List<MaintenanceWindow>	getMaintenanceWindows() Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
PresignedUrlConfig	getPresignedUrlConfig()
List<Tag>	getTags() Metadata that can be used to manage the job template.
TimeoutConfig	getTimeoutConfig()
int	hashCode()
void	setAbortConfig(AbortConfig abortConfig)
void	setDescription(String description) A description of the job document.
void	setDestinationPackageVersions(Collection<String> destinationPackageVersions) The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
void	setDocument(String document) The job document.
void	setDocumentSource(String documentSource) An S3 link, or S3 object URL, to the job document.
void	setJobArn(String jobArn) The ARN of the job to use as the basis for the job template.
void	setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig) Allows you to create the criteria to retry a job.
void	setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
void	setJobTemplateId(String jobTemplateId) A unique identifier for the job template.
void	setMaintenanceWindows(Collection<MaintenanceWindow> maintenanceWindows) Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
void	setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
void	setTags(Collection<Tag> tags) Metadata that can be used to manage the job template.
void	setTimeoutConfig(TimeoutConfig timeoutConfig)
String	toString() Returns a string representation of this object.
CreateJobTemplateRequest	withAbortConfig(AbortConfig abortConfig)
CreateJobTemplateRequest	withDescription(String description) A description of the job document.
CreateJobTemplateRequest	withDestinationPackageVersions(Collection<String> destinationPackageVersions) The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
CreateJobTemplateRequest	withDestinationPackageVersions(String... destinationPackageVersions) The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
CreateJobTemplateRequest	withDocument(String document) The job document.
CreateJobTemplateRequest	withDocumentSource(String documentSource) An S3 link, or S3 object URL, to the job document.
CreateJobTemplateRequest	withJobArn(String jobArn) The ARN of the job to use as the basis for the job template.
CreateJobTemplateRequest	withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig) Allows you to create the criteria to retry a job.
CreateJobTemplateRequest	withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
CreateJobTemplateRequest	withJobTemplateId(String jobTemplateId) A unique identifier for the job template.
CreateJobTemplateRequest	withMaintenanceWindows(Collection<MaintenanceWindow> maintenanceWindows) Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
CreateJobTemplateRequest	withMaintenanceWindows(MaintenanceWindow... maintenanceWindows) Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
CreateJobTemplateRequest	withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
CreateJobTemplateRequest	withTags(Collection<Tag> tags) Metadata that can be used to manage the job template.
CreateJobTemplateRequest	withTags(Tag... tags) Metadata that can be used to manage the job template.
CreateJobTemplateRequest	withTimeoutConfig(TimeoutConfig timeoutConfig)

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

CreateJobTemplateRequest

public CreateJobTemplateRequest()

Method Detail

setJobTemplateId

public void setJobTemplateId(String jobTemplateId)

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Parameters:

jobTemplateId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

getJobTemplateId

public String getJobTemplateId()

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Returns:

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

withJobTemplateId

public CreateJobTemplateRequest withJobTemplateId(String jobTemplateId)

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

Parameters:

jobTemplateId - A unique identifier for the job template. 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.

setJobArn

public void setJobArn(String jobArn)

The ARN of the job to use as the basis for the job template.

Parameters:

jobArn - The ARN of the job to use as the basis for the job template.

getJobArn

public String getJobArn()

The ARN of the job to use as the basis for the job template.

Returns:

The ARN of the job to use as the basis for the job template.

withJobArn

public CreateJobTemplateRequest withJobArn(String jobArn)

The ARN of the job to use as the basis for the job template.

Parameters:

jobArn - The ARN of the job to use as the basis for the job template.

Returns:

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

setDocumentSource

public void setDocumentSource(String documentSource)

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Parameters:

documentSource - An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

getDocumentSource

public String getDocumentSource()

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Returns:

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

withDocumentSource

public CreateJobTemplateRequest withDocumentSource(String documentSource)

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Parameters:

documentSource - An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Returns:

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

setDocument

public void setDocument(String document)

The job document. Required if you don't specify a value for documentSource.

Parameters:

document - The job document. Required if you don't specify a value for documentSource.

getDocument

public String getDocument()

The job document. Required if you don't specify a value for documentSource.

Returns:

The job document. Required if you don't specify a value for documentSource.

withDocument

public CreateJobTemplateRequest withDocument(String document)

The job document. Required if you don't specify a value for documentSource.

Parameters:

document - The job document. Required if you don't specify a value for documentSource.

Returns:

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

setDescription

public void setDescription(String description)

A description of the job document.

Parameters:

description - A description of the job document.

getDescription

public String getDescription()

A description of the job document.

Returns:

A description of the job document.

withDescription

public CreateJobTemplateRequest withDescription(String description)

A description of the job document.

Parameters:

description - A description of the job document.

Returns:

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

setPresignedUrlConfig

public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Parameters:

presignedUrlConfig -

getPresignedUrlConfig

public PresignedUrlConfig getPresignedUrlConfig()

Returns:

withPresignedUrlConfig

public CreateJobTemplateRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)

Parameters:

presignedUrlConfig -

Returns:

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

setJobExecutionsRolloutConfig

public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Parameters:

jobExecutionsRolloutConfig -

getJobExecutionsRolloutConfig

public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()

Returns:

withJobExecutionsRolloutConfig

public CreateJobTemplateRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

Parameters:

jobExecutionsRolloutConfig -

Returns:

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

setAbortConfig

public void setAbortConfig(AbortConfig abortConfig)

Parameters:

abortConfig -

getAbortConfig

public AbortConfig getAbortConfig()

Returns:

withAbortConfig

public CreateJobTemplateRequest withAbortConfig(AbortConfig abortConfig)

Parameters:

abortConfig -

Returns:

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

setTimeoutConfig

public void setTimeoutConfig(TimeoutConfig timeoutConfig)

Parameters:

timeoutConfig -

getTimeoutConfig

public TimeoutConfig getTimeoutConfig()

Returns:

withTimeoutConfig

public CreateJobTemplateRequest withTimeoutConfig(TimeoutConfig timeoutConfig)

Parameters:

timeoutConfig -

Returns:

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

getTags

public List<Tag> getTags()

Metadata that can be used to manage the job template.

Returns:

Metadata that can be used to manage the job template.

setTags

public void setTags(Collection<Tag> tags)

Metadata that can be used to manage the job template.

Parameters:

tags - Metadata that can be used to manage the job template.

withTags

public CreateJobTemplateRequest withTags(Tag... tags)

Metadata that can be used to manage the job template.

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

Parameters:

tags - Metadata that can be used to manage the job template.

Returns:

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

withTags

public CreateJobTemplateRequest withTags(Collection<Tag> tags)

Metadata that can be used to manage the job template.

Parameters:

tags - Metadata that can be used to manage the job template.

Returns:

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

setJobExecutionsRetryConfig

public void setJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)

Allows you to create the criteria to retry a job.

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

getJobExecutionsRetryConfig

public JobExecutionsRetryConfig getJobExecutionsRetryConfig()

Allows you to create the criteria to retry a job.

Returns:

Allows you to create the criteria to retry a job.

withJobExecutionsRetryConfig

public CreateJobTemplateRequest withJobExecutionsRetryConfig(JobExecutionsRetryConfig jobExecutionsRetryConfig)

Allows you to create the criteria to retry a job.

Parameters:

jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

Returns:

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

getMaintenanceWindows

public List<MaintenanceWindow> getMaintenanceWindows()

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Returns:

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

setMaintenanceWindows

public void setMaintenanceWindows(Collection<MaintenanceWindow> maintenanceWindows)

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Parameters:

maintenanceWindows - Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

withMaintenanceWindows

public CreateJobTemplateRequest withMaintenanceWindows(MaintenanceWindow... maintenanceWindows)

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

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

Parameters:

maintenanceWindows - Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Returns:

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

withMaintenanceWindows

public CreateJobTemplateRequest withMaintenanceWindows(Collection<MaintenanceWindow> maintenanceWindows)

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Parameters:

maintenanceWindows - Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Returns:

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

getDestinationPackageVersions

public List<String> getDestinationPackageVersions()

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Returns:

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

setDestinationPackageVersions

public void setDestinationPackageVersions(Collection<String> destinationPackageVersions)

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Parameters:

destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

withDestinationPackageVersions

public CreateJobTemplateRequest withDestinationPackageVersions(String... destinationPackageVersions)

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

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

Parameters:

destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Returns:

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

withDestinationPackageVersions

public CreateJobTemplateRequest withDestinationPackageVersions(Collection<String> destinationPackageVersions)

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Parameters:

destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

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