Class Subscription

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

Information about an Amazon Q Business subscription.

Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.

Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.

See Also:

  • Method Details

    • subscriptionId

      public final String subscriptionId()

      The identifier of the Amazon Q Business subscription to be updated.

      Returns:
      The identifier of the Amazon Q Business subscription to be updated.

    • subscriptionArn

      public final String subscriptionArn()

      The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.

    • principal

      public final SubscriptionPrincipal principal()

      The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

      Returns:
      The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

    • currentSubscription

      public final SubscriptionDetails currentSubscription()

      The type of your current Amazon Q Business subscription.

      Returns:
      The type of your current Amazon Q Business subscription.

    • nextSubscription

      public final SubscriptionDetails nextSubscription()

      The type of the Amazon Q Business subscription for the next month.

      Returns:
      The type of the Amazon Q Business subscription for the next month.

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