Class GetPackageVersionResponse

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

  • Method Details

    • packageVersionArn

      public final String packageVersionArn()

      The ARN for the package version.

      Returns:
      The ARN for the package version.

    • packageName

      public final String packageName()

      The name of the software package.

      Returns:
      The name of the software package.

    • versionName

      public final String versionName()

      The name of the package version.

      Returns:
      The name of the 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 were added to the package version that can be used to define a package version’s configuration.

      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 were added to the package version that can be used to define a package version’s configuration.

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

    • status

      public final PackageVersionStatus status()

      The status associated to the package version. For more information, see Package version lifecycle.

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

      Returns:
      The status associated to the package version. For more information, see Package version lifecycle.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status associated to the package version. For more information, see Package version lifecycle.

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

      Returns:
      The status associated to the package version. For more information, see Package version lifecycle.
      See Also:

    • errorReason

      public final String errorReason()

      Error reason for a package version failure during creation or update.

      Returns:
      Error reason for a package version failure during creation or update.

    • creationDate

      public final Instant creationDate()

      The date when the package version was created.

      Returns:
      The date when the package version was created.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date when the package version was last updated.

      Returns:
      The date when the package version was last updated.

    • sbom

      public final Sbom sbom()

      The software bill of materials for a software package version.

      Returns:
      The software bill of materials for a software package version.

    • sbomValidationStatus

      public final SbomValidationStatus sbomValidationStatus()

      The status of the validation for a new software bill of materials added to a software package version.

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

      Returns:
      The status of the validation for a new software bill of materials added to a software package version.
      See Also:

    • sbomValidationStatusAsString

      public final String sbomValidationStatusAsString()

      The status of the validation for a new software bill of materials added to a software package version.

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

      Returns:
      The status of the validation for a new software bill of materials added to a software package version.
      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.

    • toBuilder

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

    • builder

      public static GetPackageVersionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.