Package software.amazon.awssdk.services.iot.model

Class VersionUpdateByJobsConfig

java.lang.Object
software.amazon.awssdk.services.iot.model.VersionUpdateByJobsConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VersionUpdateByJobsConfig.Builder,VersionUpdateByJobsConfig>
@Generated("software.amazon.awssdk:codegen") public final class VersionUpdateByJobsConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VersionUpdateByJobsConfig.Builder,VersionUpdateByJobsConfig>

Configuration to manage IoT Job's package version reporting. If configured, Jobs updates the thing's reserved named shadow with the package version information up on successful job completion.

Note: For each job, the destinationPackageVersions attribute has to be set with the correct data for Jobs to report to the thing shadow.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Indicates whether the Job is enabled or not.

      Returns:
      Indicates whether the Job is enabled or not.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.

      Returns:
      The Amazon Resource Name (ARN) of the role that grants permission to the IoT jobs service to update the reserved named shadow when the job successfully completes.

    • toBuilder

      public VersionUpdateByJobsConfig.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<VersionUpdateByJobsConfig.Builder,VersionUpdateByJobsConfig>
      Returns:
      a builder for type T

    • builder

      public static VersionUpdateByJobsConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VersionUpdateByJobsConfig.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.