@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateOTAUpdateRequest() |
Modifier and Type | Method and Description |
---|---|
CreateOTAUpdateRequest |
addAdditionalParametersEntry(String key,
String value)
Add a single AdditionalParameters entry
|
CreateOTAUpdateRequest |
clearAdditionalParametersEntries()
Removes all the entries added into AdditionalParameters.
|
CreateOTAUpdateRequest |
clone() |
boolean |
equals(Object obj) |
Map<String,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.
|
String |
getDescription()
The description of the OTA update.
|
List<OTAUpdateFile> |
getFiles()
The files to be streamed by the OTA update.
|
String |
getOtaUpdateId()
The ID of the OTA update to be created.
|
List<String> |
getProtocols()
The protocol used to transfer the OTA update image.
|
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.
|
List<Tag> |
getTags()
Metadata which can be used to manage updates.
|
List<String> |
getTargets()
The devices targeted to receive OTA updates.
|
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(Map<String,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(String description)
The description of the OTA update.
|
void |
setFiles(Collection<OTAUpdateFile> files)
The files to be streamed by the OTA update.
|
void |
setOtaUpdateId(String otaUpdateId)
The ID of the OTA update to be created.
|
void |
setProtocols(Collection<String> protocols)
The protocol used to transfer the OTA update image.
|
void |
setRoleArn(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(Collection<Tag> tags)
Metadata which can be used to manage updates.
|
void |
setTargets(Collection<String> targets)
The devices targeted to receive OTA updates.
|
void |
setTargetSelection(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).
|
String |
toString()
Returns a string representation of this object.
|
CreateOTAUpdateRequest |
withAdditionalParameters(Map<String,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(String description)
The description of the OTA update.
|
CreateOTAUpdateRequest |
withFiles(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(String otaUpdateId)
The ID of the OTA update to be created.
|
CreateOTAUpdateRequest |
withProtocols(Collection<String> protocols)
The protocol used to transfer the OTA update image.
|
CreateOTAUpdateRequest |
withProtocols(Protocol... protocols)
The protocol used to transfer the OTA update image.
|
CreateOTAUpdateRequest |
withProtocols(String... protocols)
The protocol used to transfer the OTA update image.
|
CreateOTAUpdateRequest |
withRoleArn(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(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(Collection<String> targets)
The devices targeted to receive OTA updates.
|
CreateOTAUpdateRequest |
withTargets(String... targets)
The devices targeted to receive OTA updates.
|
CreateOTAUpdateRequest |
withTargetSelection(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).
|
addHandlerContext, copyBaseTo, 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
public void setOtaUpdateId(String otaUpdateId)
The ID of the OTA update to be created.
otaUpdateId
- The ID of the OTA update to be created.public String getOtaUpdateId()
The ID of the OTA update to be created.
public CreateOTAUpdateRequest withOtaUpdateId(String otaUpdateId)
The ID of the OTA update to be created.
otaUpdateId
- The ID of the OTA update to be created.public void setDescription(String description)
The description of the OTA update.
description
- The description of the OTA update.public String getDescription()
The description of the OTA update.
public CreateOTAUpdateRequest withDescription(String description)
The description of the OTA update.
description
- The description of the OTA update.public List<String> getTargets()
The devices targeted to receive OTA updates.
public void setTargets(Collection<String> targets)
The devices targeted to receive OTA updates.
targets
- The devices targeted to receive OTA updates.public CreateOTAUpdateRequest withTargets(String... targets)
The devices targeted to receive OTA updates.
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.
targets
- The devices targeted to receive OTA updates.public CreateOTAUpdateRequest withTargets(Collection<String> targets)
The devices targeted to receive OTA updates.
targets
- The devices targeted to receive OTA updates.public List<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.
Protocol
public void setProtocols(Collection<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.Protocol
public CreateOTAUpdateRequest withProtocols(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.
NOTE: This method appends the values to the existing list (if any). Use
setProtocols(java.util.Collection)
or withProtocols(java.util.Collection)
if you want to
override the existing values.
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.Protocol
public CreateOTAUpdateRequest withProtocols(Collection<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.Protocol
public CreateOTAUpdateRequest withProtocols(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.
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.Protocol
public void setTargetSelection(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.
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 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.
TargetSelection
public CreateOTAUpdateRequest withTargetSelection(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.
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.
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 setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
awsJobExecutionsRolloutConfig
- Configuration for the rollout of OTA updates.public AwsJobExecutionsRolloutConfig getAwsJobExecutionsRolloutConfig()
Configuration for the rollout of OTA updates.
public CreateOTAUpdateRequest withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
awsJobExecutionsRolloutConfig
- Configuration for the rollout of OTA updates.public void setAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
awsJobPresignedUrlConfig
- Configuration information for pre-signed URLs.public AwsJobPresignedUrlConfig getAwsJobPresignedUrlConfig()
Configuration information for pre-signed URLs.
public CreateOTAUpdateRequest withAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
awsJobPresignedUrlConfig
- Configuration information for pre-signed URLs.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 AwsJobAbortConfig getAwsJobAbortConfig()
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.
awsJobAbortConfig
- The criteria that determine when and how a job abort takes place.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 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
.
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
.
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 List<OTAUpdateFile> getFiles()
The files to be streamed by the OTA update.
public void setFiles(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.
NOTE: This method appends the values to the existing list (if any). Use
setFiles(java.util.Collection)
or withFiles(java.util.Collection)
if you want to override the
existing values.
files
- The files to be streamed by the OTA update.public CreateOTAUpdateRequest withFiles(Collection<OTAUpdateFile> files)
The files to be streamed by the OTA update.
files
- The files to be streamed by the OTA update.public void setRoleArn(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.
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 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.
public CreateOTAUpdateRequest withRoleArn(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.
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 Map<String,String> getAdditionalParameters()
A list of additional OTA update parameters which are name-value pairs.
public void setAdditionalParameters(Map<String,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(Map<String,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 addAdditionalParametersEntry(String key, String value)
public CreateOTAUpdateRequest clearAdditionalParametersEntries()
public List<Tag> getTags()
Metadata which can be used to manage updates.
public void setTags(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.
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.
tags
- Metadata which can be used to manage updates.public CreateOTAUpdateRequest withTags(Collection<Tag> tags)
Metadata which can be used to manage updates.
tags
- Metadata which can be used to manage updates.public String toString()
toString
in class Object
Object.toString()
public CreateOTAUpdateRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2021. All rights reserved.