public class CreateOTAUpdateRequest extends AmazonWebServiceRequest implements java.io.Serializable
Creates an AWS IoT OTAUpdate on a target group of things or groups.
Constructor and Description |
---|
CreateOTAUpdateRequest() |
Modifier and Type | Method and Description |
---|---|
CreateOTAUpdateRequest |
addadditionalParametersEntry(java.lang.String key,
java.lang.String value)
A list of additional OTA update parameters which are name-value pairs.
|
CreateOTAUpdateRequest |
clearadditionalParametersEntries()
Removes all the entries added into additionalParameters.
|
boolean |
equals(java.lang.Object obj) |
java.util.Map<java.lang.String,java.lang.String> |
getAdditionalParameters()
A list of additional OTA update parameters which are name-value pairs.
|
AwsJobAbortConfig |
getAwsJobAbortConfig()
The criteria that determine when and how a job abort takes place.
|
AwsJobExecutionsRolloutConfig |
getAwsJobExecutionsRolloutConfig()
Configuration for the rollout of OTA updates.
|
AwsJobPresignedUrlConfig |
getAwsJobPresignedUrlConfig()
Configuration information for pre-signed URLs.
|
AwsJobTimeoutConfig |
getAwsJobTimeoutConfig()
Specifies the amount of time each device has to finish its execution of
the job.
|
java.lang.String |
getDescription()
The description of the OTA update.
|
java.util.List<OTAUpdateFile> |
getFiles()
The files to be streamed by the OTA update.
|
java.lang.String |
getOtaUpdateId()
The ID of the OTA update to be created.
|
java.util.List<java.lang.String> |
getProtocols()
The protocol used to transfer the OTA update image.
|
java.lang.String |
getRoleArn()
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs
and AWS Code Signing resources to create an OTA update job.
|
java.util.List<Tag> |
getTags()
Metadata which can be used to manage updates.
|
java.util.List<java.lang.String> |
getTargets()
The devices targeted to receive OTA updates.
|
java.lang.String |
getTargetSelection()
Specifies whether the update will continue to run (CONTINUOUS), or will
be complete after all the things specified as targets have completed the
update (SNAPSHOT).
|
int |
hashCode() |
void |
setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A list of additional OTA update parameters which are name-value pairs.
|
void |
setAwsJobAbortConfig(AwsJobAbortConfig awsJobAbortConfig)
The criteria that determine when and how a job abort takes place.
|
void |
setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
|
void |
setAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
|
void |
setAwsJobTimeoutConfig(AwsJobTimeoutConfig awsJobTimeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job.
|
void |
setDescription(java.lang.String description)
The description of the OTA update.
|
void |
setFiles(java.util.Collection<OTAUpdateFile> files)
The files to be streamed by the OTA update.
|
void |
setOtaUpdateId(java.lang.String otaUpdateId)
The ID of the OTA update to be created.
|
void |
setProtocols(java.util.Collection<java.lang.String> protocols)
The protocol used to transfer the OTA update image.
|
void |
setRoleArn(java.lang.String roleArn)
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs
and AWS Code Signing resources to create an OTA update job.
|
void |
setTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage updates.
|
void |
setTargets(java.util.Collection<java.lang.String> targets)
The devices targeted to receive OTA updates.
|
void |
setTargetSelection(java.lang.String targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will
be complete after all the things specified as targets have completed the
update (SNAPSHOT).
|
void |
setTargetSelection(TargetSelection targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will
be complete after all the things specified as targets have completed the
update (SNAPSHOT).
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateOTAUpdateRequest |
withAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A list of additional OTA update parameters which are name-value pairs.
|
CreateOTAUpdateRequest |
withAwsJobAbortConfig(AwsJobAbortConfig awsJobAbortConfig)
The criteria that determine when and how a job abort takes place.
|
CreateOTAUpdateRequest |
withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
|
CreateOTAUpdateRequest |
withAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
|
CreateOTAUpdateRequest |
withAwsJobTimeoutConfig(AwsJobTimeoutConfig awsJobTimeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job.
|
CreateOTAUpdateRequest |
withDescription(java.lang.String description)
The description of the OTA update.
|
CreateOTAUpdateRequest |
withFiles(java.util.Collection<OTAUpdateFile> files)
The files to be streamed by the OTA update.
|
CreateOTAUpdateRequest |
withFiles(OTAUpdateFile... files)
The files to be streamed by the OTA update.
|
CreateOTAUpdateRequest |
withOtaUpdateId(java.lang.String otaUpdateId)
The ID of the OTA update to be created.
|
CreateOTAUpdateRequest |
withProtocols(java.util.Collection<java.lang.String> protocols)
The protocol used to transfer the OTA update image.
|
CreateOTAUpdateRequest |
withProtocols(java.lang.String... protocols)
The protocol used to transfer the OTA update image.
|
CreateOTAUpdateRequest |
withRoleArn(java.lang.String roleArn)
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs
and AWS Code Signing resources to create an OTA update job.
|
CreateOTAUpdateRequest |
withTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage updates.
|
CreateOTAUpdateRequest |
withTags(Tag... tags)
Metadata which can be used to manage updates.
|
CreateOTAUpdateRequest |
withTargets(java.util.Collection<java.lang.String> targets)
The devices targeted to receive OTA updates.
|
CreateOTAUpdateRequest |
withTargets(java.lang.String... targets)
The devices targeted to receive OTA updates.
|
CreateOTAUpdateRequest |
withTargetSelection(java.lang.String targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will
be complete after all the things specified as targets have completed the
update (SNAPSHOT).
|
CreateOTAUpdateRequest |
withTargetSelection(TargetSelection targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will
be complete after all the things specified as targets have completed the
update (SNAPSHOT).
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getOtaUpdateId()
The ID of the OTA update to be created.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
The ID of the OTA update to be created.
public void setOtaUpdateId(java.lang.String otaUpdateId)
The ID of the OTA update to be created.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
otaUpdateId
- The ID of the OTA update to be created.
public CreateOTAUpdateRequest withOtaUpdateId(java.lang.String otaUpdateId)
The ID of the OTA update to be created.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
otaUpdateId
- The ID of the OTA update to be created.
public java.lang.String getDescription()
The description of the OTA update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
The description of the OTA update.
public void setDescription(java.lang.String description)
The description of the OTA update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- The description of the OTA update.
public CreateOTAUpdateRequest withDescription(java.lang.String description)
The description of the OTA update.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- The description of the OTA update.
public java.util.List<java.lang.String> getTargets()
The devices targeted to receive OTA updates.
The devices targeted to receive OTA updates.
public void setTargets(java.util.Collection<java.lang.String> targets)
The devices targeted to receive OTA updates.
targets
- The devices targeted to receive OTA updates.
public CreateOTAUpdateRequest withTargets(java.lang.String... targets)
The devices targeted to receive OTA updates.
Returns a reference to this object so that method calls can be chained together.
targets
- The devices targeted to receive OTA updates.
public CreateOTAUpdateRequest withTargets(java.util.Collection<java.lang.String> targets)
The devices targeted to receive OTA updates.
Returns a reference to this object so that method calls can be chained together.
targets
- The devices targeted to receive OTA updates.
public java.util.List<java.lang.String> getProtocols()
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
public void setProtocols(java.util.Collection<java.lang.String> protocols)
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
public CreateOTAUpdateRequest withProtocols(java.lang.String... protocols)
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
Returns a reference to this object so that method calls can be chained together.
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
public CreateOTAUpdateRequest withProtocols(java.util.Collection<java.lang.String> protocols)
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
Returns a reference to this object so that method calls can be chained together.
protocols
- The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
public java.lang.String getTargetSelection()
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
TargetSelection
public void setTargetSelection(java.lang.String targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection
- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
TargetSelection
public CreateOTAUpdateRequest withTargetSelection(java.lang.String targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection
- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
TargetSelection
public void setTargetSelection(TargetSelection targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection
- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
TargetSelection
public CreateOTAUpdateRequest withTargetSelection(TargetSelection targetSelection)
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
targetSelection
- Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
TargetSelection
public AwsJobExecutionsRolloutConfig getAwsJobExecutionsRolloutConfig()
Configuration for the rollout of OTA updates.
Configuration for the rollout of OTA updates.
public void setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
awsJobExecutionsRolloutConfig
- Configuration for the rollout of OTA updates.
public CreateOTAUpdateRequest withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
Returns a reference to this object so that method calls can be chained together.
awsJobExecutionsRolloutConfig
- Configuration for the rollout of OTA updates.
public AwsJobPresignedUrlConfig getAwsJobPresignedUrlConfig()
Configuration information for pre-signed URLs.
Configuration information for pre-signed URLs.
public void setAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
awsJobPresignedUrlConfig
- Configuration information for pre-signed URLs.
public CreateOTAUpdateRequest withAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
Returns a reference to this object so that method calls can be chained together.
awsJobPresignedUrlConfig
- Configuration information for pre-signed URLs.
public AwsJobAbortConfig getAwsJobAbortConfig()
The criteria that determine when and how a job abort takes place.
The criteria that determine when and how a job abort takes place.
public void setAwsJobAbortConfig(AwsJobAbortConfig awsJobAbortConfig)
The criteria that determine when and how a job abort takes place.
awsJobAbortConfig
- The criteria that determine when and how a job abort takes place.
public CreateOTAUpdateRequest withAwsJobAbortConfig(AwsJobAbortConfig awsJobAbortConfig)
The criteria that determine when and how a job abort takes place.
Returns a reference to this object so that method calls can be chained together.
awsJobAbortConfig
- The criteria that determine when and how a job abort takes place.
public AwsJobTimeoutConfig getAwsJobTimeoutConfig()
Specifies the amount of time each device has to finish its execution of
the job. A 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 timer expires, it will be automatically
set to TIMED_OUT
.
Specifies the amount of time each device has to finish its
execution of the job. A 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 timer
expires, it will be automatically set to TIMED_OUT
.
public void setAwsJobTimeoutConfig(AwsJobTimeoutConfig awsJobTimeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job. A 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 timer expires, it will be automatically
set to TIMED_OUT
.
awsJobTimeoutConfig
-
Specifies the amount of time each device has to finish its
execution of the job. A 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 timer expires, it will be automatically set to
TIMED_OUT
.
public CreateOTAUpdateRequest withAwsJobTimeoutConfig(AwsJobTimeoutConfig awsJobTimeoutConfig)
Specifies the amount of time each device has to finish its execution of
the job. A 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 timer expires, it will be automatically
set to TIMED_OUT
.
Returns a reference to this object so that method calls can be chained together.
awsJobTimeoutConfig
-
Specifies the amount of time each device has to finish its
execution of the job. A 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 timer expires, it will be automatically set to
TIMED_OUT
.
public java.util.List<OTAUpdateFile> getFiles()
The files to be streamed by the OTA update.
The files to be streamed by the OTA update.
public void setFiles(java.util.Collection<OTAUpdateFile> files)
The files to be streamed by the OTA update.
files
- The files to be streamed by the OTA update.
public CreateOTAUpdateRequest withFiles(OTAUpdateFile... files)
The files to be streamed by the OTA update.
Returns a reference to this object so that method calls can be chained together.
files
- The files to be streamed by the OTA update.
public CreateOTAUpdateRequest withFiles(java.util.Collection<OTAUpdateFile> files)
The files to be streamed by the OTA update.
Returns a reference to this object so that method calls can be chained together.
files
- The files to be streamed by the OTA update.
public java.lang.String getRoleArn()
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
Constraints:
Length: 20 - 2048
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
public void setRoleArn(java.lang.String roleArn)
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
Constraints:
Length: 20 - 2048
roleArn
- The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
public CreateOTAUpdateRequest withRoleArn(java.lang.String roleArn)
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 20 - 2048
roleArn
- The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
public java.util.Map<java.lang.String,java.lang.String> getAdditionalParameters()
A list of additional OTA update parameters which are name-value pairs.
A list of additional OTA update parameters which are name-value pairs.
public void setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A list of additional OTA update parameters which are name-value pairs.
additionalParameters
- A list of additional OTA update parameters which are name-value pairs.
public CreateOTAUpdateRequest withAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A list of additional OTA update parameters which are name-value pairs.
Returns a reference to this object so that method calls can be chained together.
additionalParameters
- A list of additional OTA update parameters which are name-value pairs.
public CreateOTAUpdateRequest addadditionalParametersEntry(java.lang.String key, java.lang.String value)
A list of additional OTA update parameters which are name-value pairs.
The method adds a new key-value pair into additionalParameters parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into additionalParameters.value
- The corresponding value of the entry to be added into
additionalParameters.public CreateOTAUpdateRequest clearadditionalParametersEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.List<Tag> getTags()
Metadata which can be used to manage updates.
Metadata which can be used to manage updates.
public void setTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage updates.
tags
- Metadata which can be used to manage updates.
public CreateOTAUpdateRequest withTags(Tag... tags)
Metadata which can be used to manage updates.
Returns a reference to this object so that method calls can be chained together.
tags
- Metadata which can be used to manage updates.
public CreateOTAUpdateRequest withTags(java.util.Collection<Tag> tags)
Metadata which can be used to manage updates.
Returns a reference to this object so that method calls can be chained together.
tags
- Metadata which can be used to manage updates.
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.