public class CreateJobRequest extends AmazonWebServiceRequest implements java.io.Serializable
Creates a job.
Constructor and Description |
---|
CreateJobRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
AbortConfig |
getAbortConfig()
Allows you to create criteria to abort a job.
|
java.lang.String |
getDescription()
A short text description of the job.
|
java.lang.String |
getDocument()
The job document.
|
java.lang.String |
getDocumentSource()
An S3 link to the job document.
|
JobExecutionsRolloutConfig |
getJobExecutionsRolloutConfig()
Allows you to create a staged rollout of the job.
|
java.lang.String |
getJobId()
A job identifier which must be unique for your AWS account.
|
java.lang.String |
getNamespaceId()
The namespace used to indicate that a job is a customer-managed job.
|
PresignedUrlConfig |
getPresignedUrlConfig()
Configuration information for pre-signed S3 URLs.
|
java.util.List<Tag> |
getTags()
Metadata which can be used to manage the job.
|
java.util.List<java.lang.String> |
getTargets()
A list of things and thing groups to which the job should be sent.
|
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).
|
TimeoutConfig |
getTimeoutConfig()
Specifies the amount of time each device has to finish its execution of
the job.
|
int |
hashCode() |
void |
setAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
|
void |
setDescription(java.lang.String description)
A short text description of the job.
|
void |
setDocument(java.lang.String document)
The job document.
|
void |
setDocumentSource(java.lang.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(java.lang.String jobId)
A job identifier which must be unique for your AWS account.
|
void |
setNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
void |
setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
|
void |
setTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage the job.
|
void |
setTargets(java.util.Collection<java.lang.String> targets)
A list of things and thing groups to which the job should be sent.
|
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 |
setTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateJobRequest |
withAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
|
CreateJobRequest |
withDescription(java.lang.String description)
A short text description of the job.
|
CreateJobRequest |
withDocument(java.lang.String document)
The job document.
|
CreateJobRequest |
withDocumentSource(java.lang.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(java.lang.String jobId)
A job identifier which must be unique for your AWS account.
|
CreateJobRequest |
withNamespaceId(java.lang.String namespaceId)
The namespace used to indicate that a job is a customer-managed job.
|
CreateJobRequest |
withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
|
CreateJobRequest |
withTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage the job.
|
CreateJobRequest |
withTags(Tag... tags)
Metadata which can be used to manage the job.
|
CreateJobRequest |
withTargets(java.util.Collection<java.lang.String> targets)
A list of things and thing groups to which the job should be sent.
|
CreateJobRequest |
withTargets(java.lang.String... targets)
A list of things and thing groups to which the job should be sent.
|
CreateJobRequest |
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).
|
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).
|
CreateJobRequest |
withTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.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.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
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.
public void setJobId(java.lang.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.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
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.
public CreateJobRequest withJobId(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_-]+
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.
public java.util.List<java.lang.String> getTargets()
A list of things and thing groups to which the job should be sent.
A list of things and thing groups to which the job should be sent.
public void setTargets(java.util.Collection<java.lang.String> targets)
A list of things and thing groups to which the job should be sent.
targets
- A list of things and thing groups to which the job should be sent.
public CreateJobRequest withTargets(java.lang.String... targets)
A list of things and thing groups to which the job should be sent.
Returns a reference to this object so that method calls can be chained together.
targets
- A list of things and thing groups to which the job should be sent.
public CreateJobRequest withTargets(java.util.Collection<java.lang.String> targets)
A list of things and thing groups to which the job should be sent.
Returns a reference to this object so that method calls can be chained together.
targets
- A list of things and thing groups to which the job should be sent.
public java.lang.String getDocumentSource()
An S3 link to the job document.
Constraints:
Length: 1 - 1350
An S3 link to the job document.
public void setDocumentSource(java.lang.String documentSource)
An S3 link to the job document.
Constraints:
Length: 1 - 1350
documentSource
- An S3 link to the job document.
public CreateJobRequest withDocumentSource(java.lang.String documentSource)
An S3 link to the job document.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1350
documentSource
- An S3 link to the job document.
public java.lang.String getDocument()
The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
Constraints:
Length: - 32768
The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
public void setDocument(java.lang.String document)
The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
Constraints:
Length: - 32768
document
- The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
public CreateJobRequest withDocument(java.lang.String document)
The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 32768
document
- The job document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
public java.lang.String getDescription()
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
A short text description of the job.
public void setDescription(java.lang.String description)
A short text description of the job.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- A short text description of the job.
public CreateJobRequest withDescription(java.lang.String description)
A short text description of the job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- A short text description of the job.
public PresignedUrlConfig getPresignedUrlConfig()
Configuration information for pre-signed S3 URLs.
Configuration information for pre-signed S3 URLs.
public void setPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
presignedUrlConfig
- Configuration information for pre-signed S3 URLs.
public CreateJobRequest withPresignedUrlConfig(PresignedUrlConfig presignedUrlConfig)
Configuration information for pre-signed S3 URLs.
Returns a reference to this object so that method calls can be chained together.
presignedUrlConfig
- Configuration information for pre-signed S3 URLs.
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
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.
TargetSelection
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
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.
TargetSelection
public CreateJobRequest 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
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.
TargetSelection
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
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.
TargetSelection
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelection
public JobExecutionsRolloutConfig getJobExecutionsRolloutConfig()
Allows you to create a staged rollout of the job.
Allows you to create a staged rollout of the job.
public void setJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
jobExecutionsRolloutConfig
- Allows you to create a staged rollout of the job.
public CreateJobRequest withJobExecutionsRolloutConfig(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)
Allows you to create a staged rollout of the job.
Returns a reference to this object so that method calls can be chained together.
jobExecutionsRolloutConfig
- Allows you to create a staged rollout of the job.
public AbortConfig getAbortConfig()
Allows you to create criteria to abort a job.
Allows you to create criteria to abort a job.
public void setAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
abortConfig
- Allows you to create criteria to abort a job.
public CreateJobRequest withAbortConfig(AbortConfig abortConfig)
Allows you to create criteria to abort a job.
Returns a reference to this object so that method calls can be chained together.
abortConfig
- Allows you to create criteria to abort a job.
public TimeoutConfig getTimeoutConfig()
Specifies the amount of time each device has to finish its execution of
the job. The timer is started when the job execution status is set to
IN_PROGRESS
. If the job execution status is not set to
another terminal state before the time expires, it will be automatically
set to TIMED_OUT
.
Specifies the amount of time each device has to finish its
execution of the job. The timer is started when the job execution
status is set to IN_PROGRESS
. If the job execution
status is not set to another terminal state before the time
expires, it will be automatically set to TIMED_OUT
.
public void setTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job. The timer is started when the job execution status is set to
IN_PROGRESS
. If the job execution status is not set to
another terminal state before the time expires, it will be automatically
set to TIMED_OUT
.
timeoutConfig
-
Specifies the amount of time each device has to finish its
execution of the job. The timer is started when the job
execution status is set to IN_PROGRESS
. If the
job execution status is not set to another terminal state
before the time expires, it will be automatically set to
TIMED_OUT
.
public CreateJobRequest withTimeoutConfig(TimeoutConfig timeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job. The timer is started when the job execution status is set to
IN_PROGRESS
. If the job execution status is not set to
another terminal state before the time expires, it will be automatically
set to TIMED_OUT
.
Returns a reference to this object so that method calls can be chained together.
timeoutConfig
-
Specifies the amount of time each device has to finish its
execution of the job. The timer is started when the job
execution status is set to IN_PROGRESS
. If the
job execution status is not set to another terminal state
before the time expires, it will be automatically set to
TIMED_OUT
.
public java.util.List<Tag> getTags()
Metadata which can be used to manage the job.
Metadata which can be used to manage the job.
public void setTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage the job.
tags
- Metadata which can be used to manage the job.
public CreateJobRequest withTags(Tag... tags)
Metadata which can be used to manage the job.
Returns a reference to this object so that method calls can be chained together.
tags
- Metadata which can be used to manage the job.
public CreateJobRequest withTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage the job.
Returns a reference to this object so that method calls can be chained together.
tags
- Metadata which can be used to manage the job.
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_-]+
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.
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_-]+
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.
public CreateJobRequest 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_-]+
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.