public class OTAUpdateInfo
extends java.lang.Object
implements java.io.Serializable
Information about an OTA update.
Constructor and Description |
---|
OTAUpdateInfo() |
Modifier and Type | Method and Description |
---|---|
OTAUpdateInfo |
addadditionalParametersEntry(java.lang.String key,
java.lang.String value)
A collection of name/value pairs
|
OTAUpdateInfo |
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 collection of name/value pairs
|
java.lang.String |
getAwsIotJobArn()
The AWS IoT job ARN associated with the OTA update.
|
java.lang.String |
getAwsIotJobId()
The AWS IoT job ID associated with the OTA update.
|
AwsJobExecutionsRolloutConfig |
getAwsJobExecutionsRolloutConfig()
Configuration for the rollout of OTA updates.
|
AwsJobPresignedUrlConfig |
getAwsJobPresignedUrlConfig()
Configuration information for pre-signed URLs.
|
java.util.Date |
getCreationDate()
The date when the OTA update was created.
|
java.lang.String |
getDescription()
A description of the OTA update.
|
ErrorInfo |
getErrorInfo()
Error information associated with the OTA update.
|
java.util.Date |
getLastModifiedDate()
The date when the OTA update was last updated.
|
java.lang.String |
getOtaUpdateArn()
The OTA update ARN.
|
java.util.List<OTAUpdateFile> |
getOtaUpdateFiles()
A list of files associated with the OTA update.
|
java.lang.String |
getOtaUpdateId()
The OTA update ID.
|
java.lang.String |
getOtaUpdateStatus()
The status of the OTA update.
|
java.util.List<java.lang.String> |
getProtocols()
The protocol used to transfer the OTA update image.
|
java.util.List<java.lang.String> |
getTargets()
The targets of the OTA update.
|
java.lang.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 |
setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A collection of name/value pairs
|
void |
setAwsIotJobArn(java.lang.String awsIotJobArn)
The AWS IoT job ARN associated with the OTA update.
|
void |
setAwsIotJobId(java.lang.String awsIotJobId)
The AWS IoT job ID associated with the OTA update.
|
void |
setAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
|
void |
setAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
|
void |
setCreationDate(java.util.Date creationDate)
The date when the OTA update was created.
|
void |
setDescription(java.lang.String description)
A description of the OTA update.
|
void |
setErrorInfo(ErrorInfo errorInfo)
Error information associated with the OTA update.
|
void |
setLastModifiedDate(java.util.Date lastModifiedDate)
The date when the OTA update was last updated.
|
void |
setOtaUpdateArn(java.lang.String otaUpdateArn)
The OTA update ARN.
|
void |
setOtaUpdateFiles(java.util.Collection<OTAUpdateFile> otaUpdateFiles)
A list of files associated with the OTA update.
|
void |
setOtaUpdateId(java.lang.String otaUpdateId)
The OTA update ID.
|
void |
setOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)
The status of the OTA update.
|
void |
setOtaUpdateStatus(java.lang.String otaUpdateStatus)
The status of the OTA update.
|
void |
setProtocols(java.util.Collection<java.lang.String> protocols)
The protocol used to transfer the OTA update image.
|
void |
setTargets(java.util.Collection<java.lang.String> targets)
The targets of the OTA update.
|
void |
setTargetSelection(java.lang.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).
|
void |
setTargetSelection(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).
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
OTAUpdateInfo |
withAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A collection of name/value pairs
|
OTAUpdateInfo |
withAwsIotJobArn(java.lang.String awsIotJobArn)
The AWS IoT job ARN associated with the OTA update.
|
OTAUpdateInfo |
withAwsIotJobId(java.lang.String awsIotJobId)
The AWS IoT job ID associated with the OTA update.
|
OTAUpdateInfo |
withAwsJobExecutionsRolloutConfig(AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig)
Configuration for the rollout of OTA updates.
|
OTAUpdateInfo |
withAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs.
|
OTAUpdateInfo |
withCreationDate(java.util.Date creationDate)
The date when the OTA update was created.
|
OTAUpdateInfo |
withDescription(java.lang.String description)
A description of the OTA update.
|
OTAUpdateInfo |
withErrorInfo(ErrorInfo errorInfo)
Error information associated with the OTA update.
|
OTAUpdateInfo |
withLastModifiedDate(java.util.Date lastModifiedDate)
The date when the OTA update was last updated.
|
OTAUpdateInfo |
withOtaUpdateArn(java.lang.String otaUpdateArn)
The OTA update ARN.
|
OTAUpdateInfo |
withOtaUpdateFiles(java.util.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(java.lang.String otaUpdateId)
The OTA update ID.
|
OTAUpdateInfo |
withOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)
The status of the OTA update.
|
OTAUpdateInfo |
withOtaUpdateStatus(java.lang.String otaUpdateStatus)
The status of the OTA update.
|
OTAUpdateInfo |
withProtocols(java.util.Collection<java.lang.String> protocols)
The protocol used to transfer the OTA update image.
|
OTAUpdateInfo |
withProtocols(java.lang.String... protocols)
The protocol used to transfer the OTA update image.
|
OTAUpdateInfo |
withTargets(java.util.Collection<java.lang.String> targets)
The targets of the OTA update.
|
OTAUpdateInfo |
withTargets(java.lang.String... targets)
The targets of the OTA update.
|
OTAUpdateInfo |
withTargetSelection(java.lang.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).
|
public java.lang.String getOtaUpdateId()
The OTA update ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
The OTA update ID.
public void setOtaUpdateId(java.lang.String otaUpdateId)
The OTA update ID.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_-]+
otaUpdateId
- The OTA update ID.
public OTAUpdateInfo withOtaUpdateId(java.lang.String otaUpdateId)
The OTA update ID.
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 OTA update ID.
public java.lang.String getOtaUpdateArn()
The OTA update ARN.
The OTA update ARN.
public void setOtaUpdateArn(java.lang.String otaUpdateArn)
The OTA update ARN.
otaUpdateArn
- The OTA update ARN.
public OTAUpdateInfo withOtaUpdateArn(java.lang.String otaUpdateArn)
The OTA update ARN.
Returns a reference to this object so that method calls can be chained together.
otaUpdateArn
- The OTA update ARN.
public java.util.Date getCreationDate()
The date when the OTA update was created.
The date when the OTA update was created.
public void setCreationDate(java.util.Date creationDate)
The date when the OTA update was created.
creationDate
- The date when the OTA update was created.
public OTAUpdateInfo withCreationDate(java.util.Date creationDate)
The date when the OTA update was created.
Returns a reference to this object so that method calls can be chained together.
creationDate
- The date when the OTA update was created.
public java.util.Date getLastModifiedDate()
The date when the OTA update was last updated.
The date when the OTA update was last updated.
public void setLastModifiedDate(java.util.Date lastModifiedDate)
The date when the OTA update was last updated.
lastModifiedDate
- The date when the OTA update was last updated.
public OTAUpdateInfo withLastModifiedDate(java.util.Date lastModifiedDate)
The date when the OTA update was last updated.
Returns a reference to this object so that method calls can be chained together.
lastModifiedDate
- The date when the OTA update was last updated.
public java.lang.String getDescription()
A description of the OTA update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
A description of the OTA update.
public void setDescription(java.lang.String description)
A description of the OTA update.
Constraints:
Length: - 2028
Pattern: [^\p{C}]+
description
- A description of the OTA update.
public OTAUpdateInfo withDescription(java.lang.String description)
A 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
- A description of the OTA update.
public java.util.List<java.lang.String> getTargets()
The targets of the OTA update.
The targets of the OTA update.
public void setTargets(java.util.Collection<java.lang.String> targets)
The targets of the OTA update.
targets
- The targets of the OTA update.
public OTAUpdateInfo withTargets(java.lang.String... targets)
The targets of the OTA update.
Returns a reference to this object so that method calls can be chained together.
targets
- The targets of the OTA update.
public OTAUpdateInfo withTargets(java.util.Collection<java.lang.String> targets)
The targets of the OTA update.
Returns a reference to this object so that method calls can be chained together.
targets
- The targets of the OTA update.
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 OTAUpdateInfo 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 OTAUpdateInfo 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 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 OTAUpdateInfo 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. Valid when
protocols
contains HTTP.
Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.
public void setAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.
awsJobPresignedUrlConfig
-
Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.
public OTAUpdateInfo withAwsJobPresignedUrlConfig(AwsJobPresignedUrlConfig awsJobPresignedUrlConfig)
Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.
Returns a reference to this object so that method calls can be chained together.
awsJobPresignedUrlConfig
-
Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.
public java.lang.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.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelection
public void setTargetSelection(java.lang.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.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelection
public OTAUpdateInfo withTargetSelection(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelection
public void setTargetSelection(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.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelection
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CONTINUOUS, SNAPSHOT
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.
TargetSelection
public java.util.List<OTAUpdateFile> getOtaUpdateFiles()
A list of files associated with the OTA update.
A list of files associated with the OTA update.
public void setOtaUpdateFiles(java.util.Collection<OTAUpdateFile> otaUpdateFiles)
A list of files associated with the OTA update.
otaUpdateFiles
- A list of files associated with the OTA update.
public OTAUpdateInfo withOtaUpdateFiles(OTAUpdateFile... otaUpdateFiles)
A list of files associated with the OTA update.
Returns a reference to this object so that method calls can be chained together.
otaUpdateFiles
- A list of files associated with the OTA update.
public OTAUpdateInfo withOtaUpdateFiles(java.util.Collection<OTAUpdateFile> otaUpdateFiles)
A list of files associated with the OTA update.
Returns a reference to this object so that method calls can be chained together.
otaUpdateFiles
- A list of files associated with the OTA update.
public java.lang.String getOtaUpdateStatus()
The status of the OTA update.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
The status of the OTA update.
OTAUpdateStatus
public void setOtaUpdateStatus(java.lang.String otaUpdateStatus)
The status of the OTA update.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
otaUpdateStatus
- The status of the OTA update.
OTAUpdateStatus
public OTAUpdateInfo withOtaUpdateStatus(java.lang.String otaUpdateStatus)
The status of the OTA update.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
otaUpdateStatus
- The status of the OTA update.
OTAUpdateStatus
public void setOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)
The status of the OTA update.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
otaUpdateStatus
- The status of the OTA update.
OTAUpdateStatus
public OTAUpdateInfo withOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)
The status of the OTA update.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATE_PENDING, CREATE_IN_PROGRESS,
CREATE_COMPLETE, CREATE_FAILED
otaUpdateStatus
- The status of the OTA update.
OTAUpdateStatus
public java.lang.String getAwsIotJobId()
The AWS IoT job ID associated with the OTA update.
The AWS IoT job ID associated with the OTA update.
public void setAwsIotJobId(java.lang.String awsIotJobId)
The AWS IoT job ID associated with the OTA update.
awsIotJobId
- The AWS IoT job ID associated with the OTA update.
public OTAUpdateInfo withAwsIotJobId(java.lang.String awsIotJobId)
The AWS IoT job ID associated with the OTA update.
Returns a reference to this object so that method calls can be chained together.
awsIotJobId
- The AWS IoT job ID associated with the OTA update.
public java.lang.String getAwsIotJobArn()
The AWS IoT job ARN associated with the OTA update.
The AWS IoT job ARN associated with the OTA update.
public void setAwsIotJobArn(java.lang.String awsIotJobArn)
The AWS IoT job ARN associated with the OTA update.
awsIotJobArn
- The AWS IoT job ARN associated with the OTA update.
public OTAUpdateInfo withAwsIotJobArn(java.lang.String awsIotJobArn)
The AWS IoT job ARN associated with the OTA update.
Returns a reference to this object so that method calls can be chained together.
awsIotJobArn
- The AWS IoT job ARN associated with the OTA update.
public ErrorInfo getErrorInfo()
Error information associated with the OTA update.
Error information associated with the OTA update.
public void setErrorInfo(ErrorInfo errorInfo)
Error information associated with the OTA update.
errorInfo
- Error information associated with the OTA update.
public OTAUpdateInfo withErrorInfo(ErrorInfo errorInfo)
Error information associated with the OTA update.
Returns a reference to this object so that method calls can be chained together.
errorInfo
- Error information associated with the OTA update.
public java.util.Map<java.lang.String,java.lang.String> getAdditionalParameters()
A collection of name/value pairs
A collection of name/value pairs
public void setAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A collection of name/value pairs
additionalParameters
- A collection of name/value pairs
public OTAUpdateInfo withAdditionalParameters(java.util.Map<java.lang.String,java.lang.String> additionalParameters)
A collection of name/value pairs
Returns a reference to this object so that method calls can be chained together.
additionalParameters
- A collection of name/value pairs
public OTAUpdateInfo addadditionalParametersEntry(java.lang.String key, java.lang.String value)
A collection of 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 OTAUpdateInfo clearadditionalParametersEntries()
Returns a reference to this object so that method calls can be chained together.
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.