Class OTAUpdateInfo

java.lang.Object
software.amazon.awssdk.services.iot.model.OTAUpdateInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OTAUpdateInfo.Builder,OTAUpdateInfo>

@Generated("software.amazon.awssdk:codegen") public final class OTAUpdateInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OTAUpdateInfo.Builder,OTAUpdateInfo>

Information about an OTA update.

See Also:
  • Method Details

    • otaUpdateId

      public final String otaUpdateId()

      The OTA update ID.

      Returns:
      The OTA update ID.
    • otaUpdateArn

      public final String otaUpdateArn()

      The OTA update ARN.

      Returns:
      The OTA update ARN.
    • creationDate

      public final Instant creationDate()

      The date when the OTA update was created.

      Returns:
      The date when the OTA update was created.
    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date when the OTA update was last updated.

      Returns:
      The date when the OTA update was last updated.
    • description

      public final String 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 the isEmpty() 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

      public final List<String> 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

      public final List<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.

      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 the isEmpty() 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

      public final List<String> 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

      public final AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig()

      Configuration for the rollout of OTA updates.

      Returns:
      Configuration for the rollout of OTA updates.
    • awsJobPresignedUrlConfig

      public final AwsJobPresignedUrlConfig 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

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().

      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

      public final String 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 return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().

      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 the isEmpty() 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

      public final List<OTAUpdateFile> 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

      public final OTAUpdateStatus 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 return OTAUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from otaUpdateStatusAsString().

      Returns:
      The status of the OTA update.
      See Also:
    • otaUpdateStatusAsString

      public final String 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 return OTAUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from otaUpdateStatusAsString().

      Returns:
      The status of the OTA update.
      See Also:
    • awsIotJobId

      public final String awsIotJobId()

      The IoT job ID associated with the OTA update.

      Returns:
      The IoT job ID associated with the OTA update.
    • awsIotJobArn

      public final String awsIotJobArn()

      The IoT job ARN associated with the OTA update.

      Returns:
      The IoT job ARN associated with the OTA update.
    • errorInfo

      public final ErrorInfo 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 the isEmpty() 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

      public final Map<String,String> 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

      public OTAUpdateInfo.Builder 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 interface ToCopyableBuilder<OTAUpdateInfo.Builder,OTAUpdateInfo>
      Returns:
      a builder for type T
    • builder

      public static OTAUpdateInfo.Builder builder()
    • serializableBuilderClass

      public static Class<? extends OTAUpdateInfo.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final 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
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.