Class DescribeProvisioningParametersResponse

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

  • Method Details

    • hasProvisioningArtifactParameters

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

    • provisioningArtifactParameters

      public final List<ProvisioningArtifactParameter> provisioningArtifactParameters()

      Information about the parameters used to provision the product.

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

      Returns:
      Information about the parameters used to provision the product.

    • hasConstraintSummaries

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

    • constraintSummaries

      public final List<ConstraintSummary> constraintSummaries()

      Information about the constraints used to provision the product.

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

      Returns:
      Information about the constraints used to provision the product.

    • hasUsageInstructions

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

    • usageInstructions

      public final List<UsageInstruction> usageInstructions()

      Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

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

      Returns:
      Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

    • hasTagOptions

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

    • tagOptions

      public final List<TagOptionSummary> tagOptions()

      Information about the TagOptions associated with the resource.

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

      Returns:
      Information about the TagOptions associated with the resource.

    • provisioningArtifactPreferences

      public final ProvisioningArtifactPreferences provisioningArtifactPreferences()

      An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

      Returns:
      An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

    • hasProvisioningArtifactOutputs

      @Deprecated public final boolean hasProvisioningArtifactOutputs()
      Deprecated.
      This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.
      For responses, this returns true if the service returned a value for the ProvisioningArtifactOutputs 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.

    • provisioningArtifactOutputs

      @Deprecated public final List<ProvisioningArtifactOutput> provisioningArtifactOutputs()
      Deprecated.
      This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.

      The output of the provisioning artifact.

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

      Returns:
      The output of the provisioning artifact.

    • hasProvisioningArtifactOutputKeys

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

    • provisioningArtifactOutputKeys

      public final List<ProvisioningArtifactOutput> provisioningArtifactOutputKeys()

      A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

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

      Returns:
      A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

    • toBuilder

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

    • builder

      public static DescribeProvisioningParametersResponse.Builder builder()

    • serializableBuilderClass

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