CreateOTAUpdateRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.CreateOTAUpdateRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class CreateOTAUpdateRequest
extends AmazonWebServiceRequest
implements Serializable
```
Creates an AWS IoT OTAUpdate on a target group of things or groups.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateOTAUpdateRequest()

Constructors
Constructor and Description
`CreateOTAUpdateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateOTAUpdateRequest`	`addadditionalParametersEntry(String key, 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(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).
`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).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateOTAUpdateRequest
```
public CreateOTAUpdateRequest()
```
- Method Detail
  - getOtaUpdateId
```
public String getOtaUpdateId()
```
    The ID of the OTA update to be created.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_-]+
    
    Returns:
    
    The ID of the OTA update to be created.
  - setOtaUpdateId
```
public void setOtaUpdateId(String otaUpdateId)
```
    The ID of the OTA update to be created.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_-]+
    
    Parameters:
    
    otaUpdateId -
    The ID of the OTA update to be created.
  - withOtaUpdateId
```
public CreateOTAUpdateRequest withOtaUpdateId(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_-]+
    
    Parameters:
    
    otaUpdateId -
    The ID of the OTA update to be created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    The description of the OTA update.
    
    Constraints:
    Length: - 2028
    Pattern: [^\p{C}]+
    
    Returns:
    
    The description of the OTA update.
  - setDescription
```
public void setDescription(String description)
```
    The description of the OTA update.
    
    Constraints:
    Length: - 2028
    Pattern: [^\p{C}]+
    
    Parameters:
    
    description -
    The description of the OTA update.
  - withDescription
```
public CreateOTAUpdateRequest withDescription(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}]+
    
    Parameters:
    
    description -
    The description of the OTA update.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targets -
    The targeted devices to receive OTA updates.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTargets
```
public CreateOTAUpdateRequest withTargets(Collection<String> targets)
```
    The targeted devices to receive OTA updates.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    targets -
    The targeted devices to receive OTA updates.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    
    Constraints:
    Allowed 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
  - 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.
    
    Constraints:
    Allowed 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
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed 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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - setTargetSelection
```
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
    
    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
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed 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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - getAwsJobExecutionsRolloutConfig
```
public AwsJobExecutionsRolloutConfig getAwsJobExecutionsRolloutConfig()
```
    Configuration for the rollout of OTA updates.
    
    Returns:
    
    Configuration for the rollout of OTA updates.
  - setAwsJobExecutionsRolloutConfig
```
public void setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
```
    Configuration for the rollout of OTA updates.
    
    Parameters:
    
    awsJobExecutionsRolloutConfig -
    Configuration for the rollout of OTA updates.
  - withAwsJobExecutionsRolloutConfig
```
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.
    
    Parameters:
    
    awsJobExecutionsRolloutConfig -
    Configuration for the rollout of OTA updates.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    files -
    The files to be streamed by the OTA update.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    files -
    The files to be streamed by the OTA update.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRoleArn
```
public String getRoleArn()
```
    The IAM role that allows access to the AWS IoT Jobs service.
    
    Constraints:
    Length: 20 - 2048
    
    Returns:
    
    The IAM role that allows access to the AWS IoT Jobs service.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The IAM role that allows access to the AWS IoT Jobs service.
    
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    roleArn -
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    roleArn -
    The IAM role that allows access to the AWS IoT Jobs service.
    
    Returns:
    
    A reference to this updated 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    additionalParameters -
    A list of additional OTA update parameters which are name-value pairs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addadditionalParametersEntry
```
public CreateOTAUpdateRequest addadditionalParametersEntry(String key,
                                                           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.
    
    Parameters:
    
    key - The key of the entry to be added into additionalParameters.
    
    value - The corresponding value of the entry to be added into additionalParameters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearadditionalParametersEntries
```
public CreateOTAUpdateRequest clearadditionalParametersEntries()
```
    Removes all the entries added into additionalParameters.
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    Metadata which can be used to manage updates.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public CreateOTAUpdateRequest withTags(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.
    
    Parameters:
    
    tags -
    Metadata which can be used to manage updates.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CreateOTAUpdateRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateOTAUpdateRequest

Method Detail

getOtaUpdateId

setOtaUpdateId

withOtaUpdateId

getDescription

setDescription

withDescription

getTargets

setTargets

withTargets

withTargets

getTargetSelection

setTargetSelection

withTargetSelection

setTargetSelection

withTargetSelection

getAwsJobExecutionsRolloutConfig

setAwsJobExecutionsRolloutConfig

withAwsJobExecutionsRolloutConfig

getFiles

setFiles

withFiles

withFiles

getRoleArn

setRoleArn

withRoleArn

getAdditionalParameters

setAdditionalParameters

withAdditionalParameters

addadditionalParametersEntry

clearadditionalParametersEntries

getTags

setTags

withTags

withTags

toString

hashCode

equals