Class Subscription

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

The full details of a flat-rate pricing subscription, including its current configuration, status, and associated resources.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that uniquely identifies this subscription.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies this subscription.

    • planFamily

      public final String planFamily()

      The pricing plan family for the subscription, such as CloudFront.

      Returns:
      The pricing plan family for the subscription, such as CloudFront.

    • planTier

      public final String planTier()

      The current tier level of the pricing plan, such as FREE, PRO, BUSINESS, or PREMIUM.

      Returns:
      The current tier level of the pricing plan, such as FREE, PRO, BUSINESS, or PREMIUM.

    • usageLevel

      public final String usageLevel()

      The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

      Returns:
      The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.

    • scheduledChange

      public final ScheduledChange scheduledChange()

      A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

      Returns:
      A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.

    • status

      public final Status status()

      The current status of the subscription. For the list of possible values, see the Status type.

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

      Returns:
      The current status of the subscription. For the list of possible values, see the Status type.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the subscription. For the list of possible values, see the Status type.

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

      Returns:
      The current status of the subscription. For the list of possible values, see the Status type.
      See Also:

    • statusReason

      public final String statusReason()

      A human-readable explanation of the current status, present when additional context is available.

      Returns:
      A human-readable explanation of the current status, present when additional context is available.

    • hasResourceArns

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

    • resourceArns

      public final List<String> resourceArns()

      The ARNs of the AWS resources covered by this subscription.

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

      Returns:
      The ARNs of the AWS resources covered by this subscription.

    • createdAt

      public final Instant createdAt()

      The date and time when the subscription was created, in ISO 8601 format.

      Returns:
      The date and time when the subscription was created, in ISO 8601 format.

    • updatedAt

      public final Instant updatedAt()

      The date and time when the subscription was last modified, in ISO 8601 format.

      Returns:
      The date and time when the subscription was last modified, in ISO 8601 format.

    • toBuilder

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

    • builder

      public static Subscription.Builder builder()

    • serializableBuilderClass

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