OTAUpdateInfo (AWS Java SDK for AWS IoT 1.11.693 API)

java.lang.Object
- com.amazonaws.services.iot.model.OTAUpdateInfo

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OTAUpdateInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about an OTA update.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

OTAUpdateInfo()

Constructors
Constructor and Description
`OTAUpdateInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OTAUpdateInfo`	`addAdditionalParametersEntry(String key, String value)`
`OTAUpdateInfo`	`clearAdditionalParametersEntries()` Removes all the entries added into AdditionalParameters.
`OTAUpdateInfo`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAdditionalParameters()` A collection of name/value pairs
`String`	`getAwsIotJobArn()` The AWS IoT job ARN associated with the OTA update.
`String`	`getAwsIotJobId()` The AWS IoT job ID associated with the OTA update.
`AwsJobExecutionsRolloutConfig`	`getAwsJobExecutionsRolloutConfig()` Configuration for the rollout of OTA updates.
`Date`	`getCreationDate()` The date when the OTA update was created.
`String`	`getDescription()` A description of the OTA update.
`ErrorInfo`	`getErrorInfo()` Error information associated with the OTA update.
`Date`	`getLastModifiedDate()` The date when the OTA update was last updated.
`String`	`getOtaUpdateArn()` The OTA update ARN.
`List<OTAUpdateFile>`	`getOtaUpdateFiles()` A list of files associated with the OTA update.
`String`	`getOtaUpdateId()` The OTA update ID.
`String`	`getOtaUpdateStatus()` The status of the OTA update.
`List<String>`	`getTargets()` The targets of the OTA update.
`String`	`getTargetSelection()` Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAdditionalParameters(Map<String,String> additionalParameters)` A collection of name/value pairs
`void`	`setAwsIotJobArn(String awsIotJobArn)` The AWS IoT job ARN associated with the OTA update.
`void`	`setAwsIotJobId(String awsIotJobId)` The AWS IoT job ID associated with the OTA update.
`void`	`setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)` Configuration for the rollout of OTA updates.
`void`	`setCreationDate(Date creationDate)` The date when the OTA update was created.
`void`	`setDescription(String description)` A description of the OTA update.
`void`	`setErrorInfo(ErrorInfo errorInfo)` Error information associated with the OTA update.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date when the OTA update was last updated.
`void`	`setOtaUpdateArn(String otaUpdateArn)` The OTA update ARN.
`void`	`setOtaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles)` A list of files associated with the OTA update.
`void`	`setOtaUpdateId(String otaUpdateId)` The OTA update ID.
`void`	`setOtaUpdateStatus(String otaUpdateStatus)` The status of the OTA update.
`void`	`setTargets(Collection<String> targets)` The targets of the OTA update.
`void`	`setTargetSelection(String targetSelection)` Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT).
`String`	`toString()` Returns a string representation of this object.
`OTAUpdateInfo`	`withAdditionalParameters(Map<String,String> additionalParameters)` A collection of name/value pairs
`OTAUpdateInfo`	`withAwsIotJobArn(String awsIotJobArn)` The AWS IoT job ARN associated with the OTA update.
`OTAUpdateInfo`	`withAwsIotJobId(String awsIotJobId)` The AWS IoT job ID associated with the OTA update.
`OTAUpdateInfo`	`withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)` Configuration for the rollout of OTA updates.
`OTAUpdateInfo`	`withCreationDate(Date creationDate)` The date when the OTA update was created.
`OTAUpdateInfo`	`withDescription(String description)` A description of the OTA update.
`OTAUpdateInfo`	`withErrorInfo(ErrorInfo errorInfo)` Error information associated with the OTA update.
`OTAUpdateInfo`	`withLastModifiedDate(Date lastModifiedDate)` The date when the OTA update was last updated.
`OTAUpdateInfo`	`withOtaUpdateArn(String otaUpdateArn)` The OTA update ARN.
`OTAUpdateInfo`	`withOtaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles)` A list of files associated with the OTA update.
`OTAUpdateInfo`	`withOtaUpdateFiles(OTAUpdateFile... otaUpdateFiles)` A list of files associated with the OTA update.
`OTAUpdateInfo`	`withOtaUpdateId(String otaUpdateId)` The OTA update ID.
`OTAUpdateInfo`	`withOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)` The status of the OTA update.
`OTAUpdateInfo`	`withOtaUpdateStatus(String otaUpdateStatus)` The status of the OTA update.
`OTAUpdateInfo`	`withTargets(Collection<String> targets)` The targets of the OTA update.
`OTAUpdateInfo`	`withTargets(String... targets)` The targets of the OTA update.
`OTAUpdateInfo`	`withTargetSelection(String targetSelection)` Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT).
`OTAUpdateInfo`	`withTargetSelection(TargetSelection targetSelection)` Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT).

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

- Constructor Detail
  - OTAUpdateInfo
```
public OTAUpdateInfo()
```
- Method Detail
  - setOtaUpdateId
```
public void setOtaUpdateId(String otaUpdateId)
```
    The OTA update ID.
    
    Parameters:
    
    otaUpdateId - The OTA update ID.
  - getOtaUpdateId
```
public String getOtaUpdateId()
```
    The OTA update ID.
    
    Returns:
    
    The OTA update ID.
  - withOtaUpdateId
```
public OTAUpdateInfo withOtaUpdateId(String otaUpdateId)
```
    The OTA update ID.
    
    Parameters:
    
    otaUpdateId - The OTA update ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOtaUpdateArn
```
public void setOtaUpdateArn(String otaUpdateArn)
```
    The OTA update ARN.
    
    Parameters:
    
    otaUpdateArn - The OTA update ARN.
  - getOtaUpdateArn
```
public String getOtaUpdateArn()
```
    The OTA update ARN.
    
    Returns:
    
    The OTA update ARN.
  - withOtaUpdateArn
```
public OTAUpdateInfo withOtaUpdateArn(String otaUpdateArn)
```
    The OTA update ARN.
    
    Parameters:
    
    otaUpdateArn - The OTA update ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date when the OTA update was created.
    
    Parameters:
    
    creationDate - The date when the OTA update was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date when the OTA update was created.
    
    Returns:
    
    The date when the OTA update was created.
  - withCreationDate
```
public OTAUpdateInfo withCreationDate(Date creationDate)
```
    The date when the OTA update was created.
    
    Parameters:
    
    creationDate - The date when the OTA update was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date when the OTA update was last updated.
    
    Parameters:
    
    lastModifiedDate - The date when the OTA update was last updated.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date when the OTA update was last updated.
    
    Returns:
    
    The date when the OTA update was last updated.
  - withLastModifiedDate
```
public OTAUpdateInfo withLastModifiedDate(Date lastModifiedDate)
```
    The date when the OTA update was last updated.
    
    Parameters:
    
    lastModifiedDate - The date when the OTA update was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the OTA update.
    
    Parameters:
    
    description - A description of the OTA update.
  - getDescription
```
public String getDescription()
```
    A description of the OTA update.
    
    Returns:
    
    A description of the OTA update.
  - withDescription
```
public OTAUpdateInfo withDescription(String description)
```
    A description of the OTA update.
    
    Parameters:
    
    description - A 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 targets of the OTA update.
    
    Returns:
    
    The targets of the OTA update.
  - setTargets
```
public void setTargets(Collection<String> targets)
```
    The targets of the OTA update.
    
    Parameters:
    
    targets - The targets of the OTA update.
  - withTargets
```
public OTAUpdateInfo withTargets(String... targets)
```
    The targets of the OTA update.
    
    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 targets of the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public OTAUpdateInfo withTargets(Collection<String> targets)
```
    The targets of the OTA update.
    
    Parameters:
    
    targets - The targets of the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 OTAUpdateInfo 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.
  - setTargetSelection
```
public void setTargetSelection(String targetSelection)
```
    Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    Parameters:
    
    targetSelection - Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    See Also:
    
    TargetSelection
  - getTargetSelection
```
public String getTargetSelection()
```
    Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    Returns:
    
    Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
public OTAUpdateInfo withTargetSelection(String targetSelection)
```
    Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    Parameters:
    
    targetSelection - Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - withTargetSelection
```
public OTAUpdateInfo withTargetSelection(TargetSelection targetSelection)
```
    Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    Parameters:
    
    targetSelection - Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TargetSelection
  - getOtaUpdateFiles
```
public List<OTAUpdateFile> getOtaUpdateFiles()
```
    A list of files associated with the OTA update.
    
    Returns:
    
    A list of files associated with the OTA update.
  - setOtaUpdateFiles
```
public void setOtaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles)
```
    A list of files associated with the OTA update.
    
    Parameters:
    
    otaUpdateFiles - A list of files associated with the OTA update.
  - withOtaUpdateFiles
```
public OTAUpdateInfo withOtaUpdateFiles(OTAUpdateFile... otaUpdateFiles)
```
    A list of files associated with the OTA update.
    
    NOTE: This method appends the values to the existing list (if any). Use setOtaUpdateFiles(java.util.Collection) or withOtaUpdateFiles(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    otaUpdateFiles - A list of files associated with the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOtaUpdateFiles
```
public OTAUpdateInfo withOtaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles)
```
    A list of files associated with the OTA update.
    
    Parameters:
    
    otaUpdateFiles - A list of files associated with the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOtaUpdateStatus
```
public void setOtaUpdateStatus(String otaUpdateStatus)
```
    The status of the OTA update.
    
    Parameters:
    
    otaUpdateStatus - The status of the OTA update.
    
    See Also:
    
    OTAUpdateStatus
  - getOtaUpdateStatus
```
public String getOtaUpdateStatus()
```
    The status of the OTA update.
    
    Returns:
    
    The status of the OTA update.
    
    See Also:
    
    OTAUpdateStatus
  - withOtaUpdateStatus
```
public OTAUpdateInfo withOtaUpdateStatus(String otaUpdateStatus)
```
    The status of the OTA update.
    
    Parameters:
    
    otaUpdateStatus - The status of the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OTAUpdateStatus
  - withOtaUpdateStatus
```
public OTAUpdateInfo withOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)
```
    The status of the OTA update.
    
    Parameters:
    
    otaUpdateStatus - The status of the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OTAUpdateStatus
  - setAwsIotJobId
```
public void setAwsIotJobId(String awsIotJobId)
```
    The AWS IoT job ID associated with the OTA update.
    
    Parameters:
    
    awsIotJobId - The AWS IoT job ID associated with the OTA update.
  - getAwsIotJobId
```
public String getAwsIotJobId()
```
    The AWS IoT job ID associated with the OTA update.
    
    Returns:
    
    The AWS IoT job ID associated with the OTA update.
  - withAwsIotJobId
```
public OTAUpdateInfo withAwsIotJobId(String awsIotJobId)
```
    The AWS IoT job ID associated with the OTA update.
    
    Parameters:
    
    awsIotJobId - The AWS IoT job ID associated with the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAwsIotJobArn
```
public void setAwsIotJobArn(String awsIotJobArn)
```
    The AWS IoT job ARN associated with the OTA update.
    
    Parameters:
    
    awsIotJobArn - The AWS IoT job ARN associated with the OTA update.
  - getAwsIotJobArn
```
public String getAwsIotJobArn()
```
    The AWS IoT job ARN associated with the OTA update.
    
    Returns:
    
    The AWS IoT job ARN associated with the OTA update.
  - withAwsIotJobArn
```
public OTAUpdateInfo withAwsIotJobArn(String awsIotJobArn)
```
    The AWS IoT job ARN associated with the OTA update.
    
    Parameters:
    
    awsIotJobArn - The AWS IoT job ARN associated with the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorInfo
```
public void setErrorInfo(ErrorInfo errorInfo)
```
    Error information associated with the OTA update.
    
    Parameters:
    
    errorInfo - Error information associated with the OTA update.
  - getErrorInfo
```
public ErrorInfo getErrorInfo()
```
    Error information associated with the OTA update.
    
    Returns:
    
    Error information associated with the OTA update.
  - withErrorInfo
```
public OTAUpdateInfo withErrorInfo(ErrorInfo errorInfo)
```
    Error information associated with the OTA update.
    
    Parameters:
    
    errorInfo - Error information associated with the OTA update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalParameters
```
public Map<String,String> getAdditionalParameters()
```
    A collection of name/value pairs
    
    Returns:
    
    A collection of name/value pairs
  - setAdditionalParameters
```
public void setAdditionalParameters(Map<String,String> additionalParameters)
```
    A collection of name/value pairs
    
    Parameters:
    
    additionalParameters - A collection of name/value pairs
  - withAdditionalParameters
```
public OTAUpdateInfo withAdditionalParameters(Map<String,String> additionalParameters)
```
    A collection of name/value pairs
    
    Parameters:
    
    additionalParameters - A collection of name/value pairs
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAdditionalParametersEntry
```
public OTAUpdateInfo addAdditionalParametersEntry(String key,
                                                  String value)
```
  - clearAdditionalParametersEntries
```
public OTAUpdateInfo clearAdditionalParametersEntries()
```
    Removes all the entries added into AdditionalParameters.
    
    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 OTAUpdateInfo clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class OTAUpdateInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OTAUpdateInfo

Method Detail

setOtaUpdateId

getOtaUpdateId

withOtaUpdateId

setOtaUpdateArn

getOtaUpdateArn

withOtaUpdateArn

setCreationDate

getCreationDate

withCreationDate

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setDescription

getDescription

withDescription

getTargets

setTargets

withTargets

withTargets

setAwsJobExecutionsRolloutConfig

getAwsJobExecutionsRolloutConfig

withAwsJobExecutionsRolloutConfig

setTargetSelection

getTargetSelection

withTargetSelection

withTargetSelection

getOtaUpdateFiles

setOtaUpdateFiles

withOtaUpdateFiles

withOtaUpdateFiles

setOtaUpdateStatus

getOtaUpdateStatus

withOtaUpdateStatus

withOtaUpdateStatus

setAwsIotJobId

getAwsIotJobId

withAwsIotJobId

setAwsIotJobArn

getAwsIotJobArn

withAwsIotJobArn

setErrorInfo

getErrorInfo

withErrorInfo

getAdditionalParameters

setAdditionalParameters

withAdditionalParameters

addAdditionalParametersEntry

clearAdditionalParametersEntries

toString

equals

hashCode

clone

marshall