Class Subscription

java.lang.Object
software.amazon.awssdk.services.outposts.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>

Provides information about your Amazon Web Services Outposts subscriptions.

See Also:

  • Method Details

    • subscriptionId

      public final String subscriptionId()

      The ID of the subscription that appears on the Amazon Web Services Billing Center console.

      Returns:
      The ID of the subscription that appears on the Amazon Web Services Billing Center console.

    • subscriptionType

      public final SubscriptionType subscriptionType()

      The type of subscription which can be one of the following:

      • ORIGINAL - The first order on the Amazon Web Services Outposts.

      • RENEWAL - Renewal requests, both month to month and longer term.

      • CAPACITY_INCREASE - Capacity scaling orders.

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

      Returns:
      The type of subscription which can be one of the following:

      • ORIGINAL - The first order on the Amazon Web Services Outposts.

      • RENEWAL - Renewal requests, both month to month and longer term.

      • CAPACITY_INCREASE - Capacity scaling orders.

      See Also:

    • subscriptionTypeAsString

      public final String subscriptionTypeAsString()

      The type of subscription which can be one of the following:

      • ORIGINAL - The first order on the Amazon Web Services Outposts.

      • RENEWAL - Renewal requests, both month to month and longer term.

      • CAPACITY_INCREASE - Capacity scaling orders.

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

      Returns:
      The type of subscription which can be one of the following:

      • ORIGINAL - The first order on the Amazon Web Services Outposts.

      • RENEWAL - Renewal requests, both month to month and longer term.

      • CAPACITY_INCREASE - Capacity scaling orders.

      See Also:

    • subscriptionStatus

      public final SubscriptionStatus subscriptionStatus()

      The status of subscription which can be one of the following:

      • INACTIVE - Subscription requests that are inactive.

      • ACTIVE - Subscription requests that are in progress and have an end date in the future.

      • CANCELLED - Subscription requests that are cancelled.

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

      Returns:
      The status of subscription which can be one of the following:

      • INACTIVE - Subscription requests that are inactive.

      • ACTIVE - Subscription requests that are in progress and have an end date in the future.

      • CANCELLED - Subscription requests that are cancelled.

      See Also:

    • subscriptionStatusAsString

      public final String subscriptionStatusAsString()

      The status of subscription which can be one of the following:

      • INACTIVE - Subscription requests that are inactive.

      • ACTIVE - Subscription requests that are in progress and have an end date in the future.

      • CANCELLED - Subscription requests that are cancelled.

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

      Returns:
      The status of subscription which can be one of the following:

      • INACTIVE - Subscription requests that are inactive.

      • ACTIVE - Subscription requests that are in progress and have an end date in the future.

      • CANCELLED - Subscription requests that are cancelled.

      See Also:

    • hasOrderIds

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

    • orderIds

      public final List<String> orderIds()

      The order ID for your 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 hasOrderIds() method.

      Returns:
      The order ID for your subscription.

    • beginDate

      public final Instant beginDate()

      The date your subscription starts.

      Returns:
      The date your subscription starts.

    • endDate

      public final Instant endDate()

      The date your subscription ends.

      Returns:
      The date your subscription ends.

    • monthlyRecurringPrice

      public final Double monthlyRecurringPrice()

      The amount you are billed each month in the subscription period.

      Returns:
      The amount you are billed each month in the subscription period.

    • upfrontPrice

      public final Double upfrontPrice()

      The amount billed when the subscription is created. This is a one-time charge.

      Returns:
      The amount billed when the subscription is created. This is a one-time charge.

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