Class ProvisionedProductPlanDetails

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

Information about a plan.

See Also:

  • Method Details

    • createdTime

      public final Instant createdTime()

      The UTC time stamp of the creation time.

      Returns:
      The UTC time stamp of the creation time.

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

    • planName

      public final String planName()

      The name of the plan.

      Returns:
      The name of the plan.

    • planId

      public final String planId()

      The plan identifier.

      Returns:
      The plan identifier.

    • provisionProductId

      public final String provisionProductId()

      The product identifier.

      Returns:
      The product identifier.

    • provisionProductName

      public final String provisionProductName()

      The user-friendly name of the provisioned product.

      Returns:
      The user-friendly name of the provisioned product.

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

    • provisioningArtifactId

      public final String provisioningArtifactId()

      The identifier of the provisioning artifact.

      Returns:
      The identifier of the provisioning artifact.

    • status

      public final ProvisionedProductPlanStatus status()

      The status.

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

      Returns:
      The status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status.

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

      Returns:
      The status.
      See Also:

    • updatedTime

      public final Instant updatedTime()

      The UTC time stamp when the plan was last updated.

      Returns:
      The UTC time stamp when the plan was last updated.

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

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

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

      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.

    • statusMessage

      public final String statusMessage()

      The status message.

      Returns:
      The status message.

    • toBuilder

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

    • builder

      public static ProvisionedProductPlanDetails.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.