Class UpdatePackageVersionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iot.model.IotRequest
software.amazon.awssdk.services.iot.model.UpdatePackageVersionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdatePackageVersionRequest extends IotRequest implements ToCopyableBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>

  • Method Details

    • packageName

      public final String packageName()

      The name of the associated software package.

      Returns:
      The name of the associated software package.

    • versionName

      public final String versionName()

      The name of the target package version.

      Returns:
      The name of the target package version.

    • description

      public final String description()

      The package version description.

      Returns:
      The package version description.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes 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.

    • attributes

      public final Map<String,String> attributes()

      Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.

      Note: Attributes can be updated only when the package version is in a draft state.

      The combined size of all the attributes on a package version is limited to 3KB.

      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 hasAttributes() method.

      Returns:
      Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.

      Note: Attributes can be updated only when the package version is in a draft state.

      The combined size of all the attributes on a package version is limited to 3KB.

    • artifact

      public final PackageVersionArtifact artifact()

      The various components that make up a software package version.

      Returns:
      The various components that make up a software package version.

    • action

      public final PackageVersionAction action()

      The status that the package version should be assigned. For more information, see Package version lifecycle.

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

      Returns:
      The status that the package version should be assigned. For more information, see Package version lifecycle.
      See Also:

    • actionAsString

      public final String actionAsString()

      The status that the package version should be assigned. For more information, see Package version lifecycle.

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

      Returns:
      The status that the package version should be assigned. For more information, see Package version lifecycle.
      See Also:

    • recipe

      public final String recipe()

      The inline job document associated with a software package version used for a quick job deployment.

      Returns:
      The inline job document associated with a software package version used for a quick job deployment.

    • clientToken

      public final String clientToken()

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      Returns:
      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    • toBuilder

      public UpdatePackageVersionRequest.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<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>
      Specified by:
      toBuilder in class IotRequest
      Returns:
      a builder for type T

    • builder

      public static UpdatePackageVersionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdatePackageVersionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.