Class UpdateProvisioningArtifactRequest

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

  • Method Details

    • acceptLanguage

      public final String acceptLanguage()

      The language code.

      • jp - Japanese

      • zh - Chinese

      Returns:
      The language code.

      • jp - Japanese

      • zh - Chinese

    • productId

      public final String productId()

      The product identifier.

      Returns:
      The product identifier.

    • provisioningArtifactId

      public final String provisioningArtifactId()

      The identifier of the provisioning artifact.

      Returns:
      The identifier of the provisioning artifact.

    • name

      public final String name()

      The updated name of the provisioning artifact.

      Returns:
      The updated name of the provisioning artifact.

    • description

      public final String description()

      The updated description of the provisioning artifact.

      Returns:
      The updated description of the provisioning artifact.

    • active

      public final Boolean active()

      Indicates whether the product version is active.

      Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

      Returns:
      Indicates whether the product version is active.

      Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

    • guidance

      public final ProvisioningArtifactGuidance guidance()

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

      The DEFAULT value indicates that the product version is active.

      The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

      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.

      The DEFAULT value indicates that the product version is active.

      The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

      See Also:

    • guidanceAsString

      public final String guidanceAsString()

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

      The DEFAULT value indicates that the product version is active.

      The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

      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.

      The DEFAULT value indicates that the product version is active.

      The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

      See Also:

    • toBuilder

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

    • builder

      public static UpdateProvisioningArtifactRequest.Builder builder()

    • serializableBuilderClass

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