Class ProvisioningArtifactDetail

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

Information about a provisioning artifact (also known as a version) for a product.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the provisioning artifact.

      Returns:
      The identifier of the provisioning artifact.

    • name

      public final String name()

      The name of the provisioning artifact.

      Returns:
      The name of the provisioning artifact.

    • description

      public final String description()

      The description of the provisioning artifact.

      Returns:
      The description of the provisioning artifact.

    • type

      public final ProvisioningArtifactType type()

      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

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

      Returns:
      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

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

      Returns:
      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

      See Also:

    • createdTime

      public final Instant createdTime()

      The UTC time stamp of the creation time.

      Returns:
      The UTC time stamp of the creation time.

    • active

      public final Boolean active()

      Indicates whether the product version is active.

      Returns:
      Indicates whether the product version is active.

    • guidance

      public final ProvisioningArtifactGuidance guidance()

      Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

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

      Returns:
      Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
      See Also:

    • guidanceAsString

      public final String guidanceAsString()

      Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

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

      Returns:
      Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
      See Also:

    • sourceRevision

      public final String sourceRevision()

      Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

      This field only exists for Repo-Synced products.

      Returns:
      Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

      This field only exists for Repo-Synced products.

    • toBuilder

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

    • builder

      public static ProvisioningArtifactDetail.Builder builder()

    • serializableBuilderClass

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