Class OTAUpdateInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OTAUpdateInfo.Builder,
OTAUpdateInfo>
Information about an OTA update.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA collection of name/value pairsfinal String
The IoT job ARN associated with the OTA update.final String
The IoT job ID associated with the OTA update.Configuration for the rollout of OTA updates.final AwsJobPresignedUrlConfig
Configuration information for pre-signed URLs.static OTAUpdateInfo.Builder
builder()
final Instant
The date when the OTA update was created.final String
A description of the OTA update.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorInfo
Error information associated with the OTA update.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdditionalParameters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OtaUpdateFiles property.final boolean
For responses, this returns true if the service returned a value for the Protocols property.final boolean
For responses, this returns true if the service returned a value for the Targets property.final Instant
The date when the OTA update was last updated.final String
The OTA update ARN.final List
<OTAUpdateFile> A list of files associated with the OTA update.final String
The OTA update ID.final OTAUpdateStatus
The status of the OTA update.final String
The status of the OTA update.The protocol used to transfer the OTA update image.The protocol used to transfer the OTA update image.static Class
<? extends OTAUpdateInfo.Builder> targets()
The targets of the OTA update.final 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).final String
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).Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
otaUpdateId
The OTA update ID.
- Returns:
- The OTA update ID.
-
otaUpdateArn
The OTA update ARN.
- Returns:
- The OTA update ARN.
-
creationDate
The date when the OTA update was created.
- Returns:
- The date when the OTA update was created.
-
lastModifiedDate
The date when the OTA update was last updated.
- Returns:
- The date when the OTA update was last updated.
-
description
A description of the OTA update.
- Returns:
- A description of the OTA update.
-
hasTargets
public final boolean hasTargets()For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
targets
The targets of the OTA update.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTargets()
method.- Returns:
- The targets of the OTA update.
-
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasProtocols()
method.- Returns:
- 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.
-
hasProtocols
public final boolean hasProtocols()For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
protocolsAsStrings
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasProtocols()
method.- Returns:
- 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.
-
awsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
- Returns:
- Configuration for the rollout of OTA updates.
-
awsJobPresignedUrlConfig
Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.- Returns:
- Configuration information for pre-signed URLs. Valid when
protocols
contains HTTP.
-
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.
If the service returns an enum value that is not available in the current SDK version,
targetSelection
will returnTargetSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetSelectionAsString()
.- 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:
-
targetSelectionAsString
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.
If the service returns an enum value that is not available in the current SDK version,
targetSelection
will returnTargetSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetSelectionAsString()
.- 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:
-
hasOtaUpdateFiles
public final boolean hasOtaUpdateFiles()For responses, this returns true if the service returned a value for the OtaUpdateFiles property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
otaUpdateFiles
A list of files associated with the OTA update.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOtaUpdateFiles()
method.- Returns:
- A list of files associated with the OTA update.
-
otaUpdateStatus
The status of the OTA update.
If the service returns an enum value that is not available in the current SDK version,
otaUpdateStatus
will returnOTAUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromotaUpdateStatusAsString()
.- Returns:
- The status of the OTA update.
- See Also:
-
otaUpdateStatusAsString
The status of the OTA update.
If the service returns an enum value that is not available in the current SDK version,
otaUpdateStatus
will returnOTAUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromotaUpdateStatusAsString()
.- Returns:
- The status of the OTA update.
- See Also:
-
awsIotJobId
The IoT job ID associated with the OTA update.
- Returns:
- The IoT job ID associated with the OTA update.
-
awsIotJobArn
The IoT job ARN associated with the OTA update.
- Returns:
- The IoT job ARN associated with the OTA update.
-
errorInfo
Error information associated with the OTA update.
- Returns:
- Error information associated with the OTA update.
-
hasAdditionalParameters
public final boolean hasAdditionalParameters()For responses, this returns true if the service returned a value for the AdditionalParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
additionalParameters
A collection of name/value pairs
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdditionalParameters()
method.- Returns:
- A collection of name/value pairs
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<OTAUpdateInfo.Builder,
OTAUpdateInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-