Class CreateProvisionedProductPlanRequest

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.CreateProvisionedProductPlanRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateProvisionedProductPlanRequest.Builder,CreateProvisionedProductPlanRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateProvisionedProductPlanRequest extends ServiceCatalogRequest implements ToCopyableBuilder<CreateProvisionedProductPlanRequest.Builder,CreateProvisionedProductPlanRequest>

  • Method Details

    • acceptLanguage

      public final String acceptLanguage()

      The language code.

      • jp - Japanese

      • zh - Chinese

      Returns:
      The language code.

      • jp - Japanese

      • zh - Chinese

    • planName

      public final String planName()

      The name of the plan.

      Returns:
      The name of the plan.

    • planType

      public final ProvisionedProductPlanType planType()

      The plan type.

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

      Returns:
      The plan type.
      See Also:

    • planTypeAsString

      public final String planTypeAsString()

      The plan type.

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

      Returns:
      The plan type.
      See Also:

    • hasNotificationArns

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

    • notificationArns

      public final List<String> notificationArns()

      Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

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

      Returns:
      Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    • pathId

      public final String pathId()

      The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

      Returns:
      The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

    • productId

      public final String productId()

      The product identifier.

      Returns:
      The product identifier.

    • provisionedProductName

      public final String provisionedProductName()

      A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

      Returns:
      A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

    • provisioningArtifactId

      public final String provisioningArtifactId()

      The identifier of the provisioning artifact.

      Returns:
      The identifier of the provisioning artifact.

    • hasProvisioningParameters

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

    • provisioningParameters

      public final List<UpdateProvisioningParameter> provisioningParameters()

      Parameters specified by the administrator that are required for provisioning 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 hasProvisioningParameters() method.

      Returns:
      Parameters specified by the administrator that are required for provisioning the product.

    • idempotencyToken

      public final String idempotencyToken()

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      Returns:
      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      One or more tags.

      If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

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

      Returns:
      One or more tags.

      If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

    • toBuilder

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

    • builder

      public static CreateProvisionedProductPlanRequest.Builder builder()

    • serializableBuilderClass

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