Class AccountSettings

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

The Amazon QuickSight settings associated with your Amazon Web Services account.

See Also:

  • Method Details

    • accountName

      public final String accountName()

      The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.

      Returns:
      The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.

    • edition

      public final Edition edition()

      The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.

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

      Returns:
      The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
      See Also:

    • editionAsString

      public final String editionAsString()

      The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.

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

      Returns:
      The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
      See Also:

    • defaultNamespace

      public final String defaultNamespace()

      The default Amazon QuickSight namespace for your Amazon Web Services account.

      Returns:
      The default Amazon QuickSight namespace for your Amazon Web Services account.

    • notificationEmail

      public final String notificationEmail()

      The main notification email for your Amazon QuickSight subscription.

      Returns:
      The main notification email for your Amazon QuickSight subscription.

    • publicSharingEnabled

      public final Boolean publicSharingEnabled()

      A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

      Returns:
      A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

    • terminationProtectionEnabled

      public final Boolean terminationProtectionEnabled()

      A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

      Returns:
      A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

    • toBuilder

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

    • builder

      public static AccountSettings.Builder builder()

    • serializableBuilderClass

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