com.amazonaws.services.iot.model

Class CreateOTAUpdateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateOTAUpdateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateOTAUpdateRequest	addAdditionalParametersEntry(String key, String value)
CreateOTAUpdateRequest	clearAdditionalParametersEntries() Removes all the entries added into AdditionalParameters.
CreateOTAUpdateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,String>	getAdditionalParameters() A list of additional OTA update parameters which are name-value pairs.
AwsJobExecutionsRolloutConfig	getAwsJobExecutionsRolloutConfig() Configuration for the rollout of OTA updates.
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.
String	getRoleArn() The IAM role that allows access to the AWS IoT Jobs service.
List<Tag>	getTags() Metadata which can be used to manage updates.
List<String>	getTargets() The targeted devices 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	setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.
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	setRoleArn(String roleArn) The IAM role that allows access to the AWS IoT Jobs service.
void	setTags(Collection<Tag> tags) Metadata which can be used to manage updates.
void	setTargets(Collection<String> targets) The targeted devices 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	withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig) Configuration for the rollout of OTA updates.
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	withRoleArn(String roleArn) The IAM role that allows access to the AWS IoT Jobs service.
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 targeted devices to receive OTA updates.
CreateOTAUpdateRequest	withTargets(String... targets) The targeted devices 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).

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

CreateOTAUpdateRequest

public CreateOTAUpdateRequest()

Method Detail

setOtaUpdateId

public void setOtaUpdateId(String otaUpdateId)

The ID of the OTA update to be created.

Parameters:

otaUpdateId - The ID of the OTA update to be created.

getOtaUpdateId

public String getOtaUpdateId()

The ID of the OTA update to be created.

Returns:

The ID of the OTA update to be created.

withOtaUpdateId

public CreateOTAUpdateRequest withOtaUpdateId(String otaUpdateId)

The ID of the OTA update to be created.

Parameters:

otaUpdateId - The ID of the OTA update to be created.

Returns:

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

setDescription

public void setDescription(String description)

The description of the OTA update.

Parameters:

description - The description of the OTA update.

getDescription

public String getDescription()

The description of the OTA update.

Returns:

The description of the OTA update.

withDescription

public CreateOTAUpdateRequest withDescription(String description)

The description of the OTA update.

Parameters:

description - The description of the OTA update.

Returns:

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

getTargets

public List<String> getTargets()

The targeted devices to receive OTA updates.

Returns:

The targeted devices to receive OTA updates.

setTargets

public void setTargets(Collection<String> targets)

The targeted devices to receive OTA updates.

Parameters:

targets - The targeted devices to receive OTA updates.

withTargets

public CreateOTAUpdateRequest withTargets(String... targets)

The targeted devices 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.

Parameters:

targets - The targeted devices to receive OTA updates.

Returns:

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

withTargets

public CreateOTAUpdateRequest withTargets(Collection<String> targets)

The targeted devices to receive OTA updates.

Parameters:

targets - The targeted devices to receive OTA updates.

Returns:

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

setTargetSelection

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.

Parameters:

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.

See Also:

TargetSelection

getTargetSelection

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.

Returns:

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.

See Also:

TargetSelection

withTargetSelection

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.

Parameters:

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:

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

See Also:

TargetSelection

withTargetSelection

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.

Parameters:

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:

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

See Also:

TargetSelection

setAwsJobExecutionsRolloutConfig

public void setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)

Configuration for the rollout of OTA updates.

Parameters:

awsJobExecutionsRolloutConfig - Configuration for the rollout of OTA updates.

getAwsJobExecutionsRolloutConfig

public AwsJobExecutionsRolloutConfig getAwsJobExecutionsRolloutConfig()

Configuration for the rollout of OTA updates.

Returns:

Configuration for the rollout of OTA updates.

withAwsJobExecutionsRolloutConfig

public CreateOTAUpdateRequest withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)

Configuration for the rollout of OTA updates.

Parameters:

awsJobExecutionsRolloutConfig - Configuration for the rollout of OTA updates.

Returns:

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

getFiles

public List<OTAUpdateFile> getFiles()

The files to be streamed by the OTA update.

Returns:

The files to be streamed by the OTA update.

setFiles

public void setFiles(Collection<OTAUpdateFile> files)

The files to be streamed by the OTA update.

Parameters:

files - The files to be streamed by the OTA update.

withFiles

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.

Parameters:

files - The files to be streamed by the OTA update.

Returns:

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

withFiles

public CreateOTAUpdateRequest withFiles(Collection<OTAUpdateFile> files)

The files to be streamed by the OTA update.

Parameters:

files - The files to be streamed by the OTA update.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The IAM role that allows access to the AWS IoT Jobs service.

Parameters:

roleArn - The IAM role that allows access to the AWS IoT Jobs service.

getRoleArn

public String getRoleArn()

The IAM role that allows access to the AWS IoT Jobs service.

Returns:

The IAM role that allows access to the AWS IoT Jobs service.

withRoleArn

public CreateOTAUpdateRequest withRoleArn(String roleArn)

The IAM role that allows access to the AWS IoT Jobs service.

Parameters:

roleArn - The IAM role that allows access to the AWS IoT Jobs service.

Returns:

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

getAdditionalParameters

public Map<String,String> getAdditionalParameters()

A list of additional OTA update parameters which are name-value pairs.

Returns:

A list of additional OTA update parameters which are name-value pairs.

setAdditionalParameters

public void setAdditionalParameters(Map<String,String> additionalParameters)

A list of additional OTA update parameters which are name-value pairs.

Parameters:

additionalParameters - A list of additional OTA update parameters which are name-value pairs.

withAdditionalParameters

public CreateOTAUpdateRequest withAdditionalParameters(Map<String,String> additionalParameters)

A list of additional OTA update parameters which are name-value pairs.

Parameters:

additionalParameters - A list of additional OTA update parameters which are name-value pairs.

Returns:

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

addAdditionalParametersEntry

public CreateOTAUpdateRequest addAdditionalParametersEntry(String key,
                                                           String value)

clearAdditionalParametersEntries

public CreateOTAUpdateRequest clearAdditionalParametersEntries()

Removes all the entries added into AdditionalParameters.

Returns:

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

getTags

public List<Tag> getTags()

Metadata which can be used to manage updates.

Returns:

Metadata which can be used to manage updates.

setTags

public void setTags(Collection<Tag> tags)

Metadata which can be used to manage updates.

Parameters:

tags - Metadata which can be used to manage updates.

withTags

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.

Parameters:

tags - Metadata which can be used to manage updates.

Returns:

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

withTags

public CreateOTAUpdateRequest withTags(Collection<Tag> tags)

Metadata which can be used to manage updates.

Parameters:

tags - Metadata which can be used to manage updates.

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