@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class OTAUpdateInfo extends Object implements Serializable, Cloneable, StructuredPojo
Information about an OTA update.
Constructor and Description |
---|
OTAUpdateInfo() |
Modifier and Type | Method and Description |
---|---|
OTAUpdateInfo |
addAdditionalParametersEntry(String key,
String value)
Add a single AdditionalParameters entry
|
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 IoT job ARN associated with the OTA update.
|
String |
getAwsIotJobId()
The 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.
|
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> |
getProtocols()
The protocol used to transfer the OTA update image.
|
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalParameters(Map<String,String> additionalParameters)
A collection of name/value pairs
|
void |
setAwsIotJobArn(String awsIotJobArn)
The IoT job ARN associated with the OTA update.
|
void |
setAwsIotJobId(String awsIotJobId)
The 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(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 |
setProtocols(Collection<String> protocols)
The protocol used to transfer the OTA update image.
|
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 IoT job ARN associated with the OTA update.
|
OTAUpdateInfo |
withAwsIotJobId(String awsIotJobId)
The 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(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 |
withProtocols(Collection<String> protocols)
The protocol used to transfer the OTA update image.
|
OTAUpdateInfo |
withProtocols(Protocol... protocols)
The protocol used to transfer the OTA update image.
|
OTAUpdateInfo |
withProtocols(String... protocols)
The protocol used to transfer the OTA update image.
|
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).
|
public void setOtaUpdateId(String otaUpdateId)
The OTA update ID.
otaUpdateId
- The OTA update ID.public String getOtaUpdateId()
The OTA update ID.
public OTAUpdateInfo withOtaUpdateId(String otaUpdateId)
The OTA update ID.
otaUpdateId
- The OTA update ID.public void setOtaUpdateArn(String otaUpdateArn)
The OTA update ARN.
otaUpdateArn
- The OTA update ARN.public String getOtaUpdateArn()
The OTA update ARN.
public OTAUpdateInfo withOtaUpdateArn(String otaUpdateArn)
The OTA update ARN.
otaUpdateArn
- The OTA update ARN.public void setCreationDate(Date creationDate)
The date when the OTA update was created.
creationDate
- The date when the OTA update was created.public Date getCreationDate()
The date when the OTA update was created.
public OTAUpdateInfo withCreationDate(Date creationDate)
The date when the OTA update was created.
creationDate
- The date when the OTA update was created.public void setLastModifiedDate(Date lastModifiedDate)
The date when the OTA update was last updated.
lastModifiedDate
- The date when the OTA update was last updated.public Date getLastModifiedDate()
The date when the OTA update was last updated.
public OTAUpdateInfo withLastModifiedDate(Date lastModifiedDate)
The date when the OTA update was last updated.
lastModifiedDate
- The date when the OTA update was last updated.public void setDescription(String description)
A description of the OTA update.
description
- A description of the OTA update.public String getDescription()
A description of the OTA update.
public OTAUpdateInfo withDescription(String description)
A description of the OTA update.
description
- A description of the OTA update.public List<String> getTargets()
The targets of the OTA update.
public void setTargets(Collection<String> targets)
The targets of the OTA update.
targets
- The targets of the OTA update.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.
targets
- The targets of the OTA update.public OTAUpdateInfo withTargets(Collection<String> targets)
The targets of the OTA update.
targets
- The targets of the OTA update.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 OTAUpdateInfo 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 OTAUpdateInfo 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 OTAUpdateInfo 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 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 OTAUpdateInfo 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. Valid when protocols
contains HTTP.
awsJobPresignedUrlConfig
- Configuration information for pre-signed URLs. Valid when protocols
contains HTTP.public AwsJobPresignedUrlConfig getAwsJobPresignedUrlConfig()
Configuration information for pre-signed URLs. Valid when protocols
contains HTTP.
protocols
contains HTTP.public OTAUpdateInfo withAwsJobPresignedUrlConfig(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 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.
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 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.
TargetSelection
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.
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.
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 List<OTAUpdateFile> getOtaUpdateFiles()
A list of files associated with the OTA update.
public void setOtaUpdateFiles(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.
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.
otaUpdateFiles
- A list of files associated with the OTA update.public OTAUpdateInfo withOtaUpdateFiles(Collection<OTAUpdateFile> otaUpdateFiles)
A list of files associated with the OTA update.
otaUpdateFiles
- A list of files associated with the OTA update.public void setOtaUpdateStatus(String otaUpdateStatus)
The status of the OTA update.
otaUpdateStatus
- The status of the OTA update.OTAUpdateStatus
public String getOtaUpdateStatus()
The status of the OTA update.
OTAUpdateStatus
public OTAUpdateInfo withOtaUpdateStatus(String otaUpdateStatus)
The status of the OTA update.
otaUpdateStatus
- The status of the OTA update.OTAUpdateStatus
public OTAUpdateInfo withOtaUpdateStatus(OTAUpdateStatus otaUpdateStatus)
The status of the OTA update.
otaUpdateStatus
- The status of the OTA update.OTAUpdateStatus
public void setAwsIotJobId(String awsIotJobId)
The IoT job ID associated with the OTA update.
awsIotJobId
- The IoT job ID associated with the OTA update.public String getAwsIotJobId()
The IoT job ID associated with the OTA update.
public OTAUpdateInfo withAwsIotJobId(String awsIotJobId)
The IoT job ID associated with the OTA update.
awsIotJobId
- The IoT job ID associated with the OTA update.public void setAwsIotJobArn(String awsIotJobArn)
The IoT job ARN associated with the OTA update.
awsIotJobArn
- The IoT job ARN associated with the OTA update.public String getAwsIotJobArn()
The IoT job ARN associated with the OTA update.
public OTAUpdateInfo withAwsIotJobArn(String awsIotJobArn)
The IoT job ARN associated with the OTA update.
awsIotJobArn
- The IoT job ARN 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 ErrorInfo getErrorInfo()
Error information associated with the OTA update.
public OTAUpdateInfo withErrorInfo(ErrorInfo errorInfo)
Error information associated with the OTA update.
errorInfo
- Error information associated with the OTA update.public Map<String,String> getAdditionalParameters()
A collection of name/value pairs
public void setAdditionalParameters(Map<String,String> additionalParameters)
A collection of name/value pairs
additionalParameters
- A collection of name/value pairspublic OTAUpdateInfo withAdditionalParameters(Map<String,String> additionalParameters)
A collection of name/value pairs
additionalParameters
- A collection of name/value pairspublic OTAUpdateInfo addAdditionalParametersEntry(String key, String value)
public OTAUpdateInfo clearAdditionalParametersEntries()
public String toString()
toString
in class Object
Object.toString()
public OTAUpdateInfo clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.