Class CreateAccountSubscriptionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.CreateAccountSubscriptionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAccountSubscriptionRequest extends QuickSightRequest implements ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>

  • Method Details

    • edition

      public final Edition edition()

      The edition of Amazon Quick Sight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      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 Quick Sight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      See Also:

    • editionAsString

      public final String editionAsString()

      The edition of Amazon Quick Sight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      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 Quick Sight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      See Also:

    • authenticationMethod

      public final AuthenticationMethodOption authenticationMethod()

      The method that you want to use to authenticate your Quick Sight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

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

      Returns:
      The method that you want to use to authenticate your Quick Sight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

      See Also:

    • authenticationMethodAsString

      public final String authenticationMethodAsString()

      The method that you want to use to authenticate your Quick Sight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

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

      Returns:
      The method that you want to use to authenticate your Quick Sight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

      See Also:

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID of the account that you're using to create your Quick Sight account.

      Returns:
      The Amazon Web Services account ID of the account that you're using to create your Quick Sight account.

    • accountName

      public final String accountName()

      The name of your Amazon Quick Sight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon Quick Sight account is created.

      Returns:
      The name of your Amazon Quick Sight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon Quick Sight account is created.

    • notificationEmail

      public final String notificationEmail()

      The email address that you want Quick Sight to send notifications to regarding your Quick Sight account or Quick Sight subscription.

      Returns:
      The email address that you want Quick Sight to send notifications to regarding your Quick Sight account or Quick Sight subscription.

    • activeDirectoryName

      public final String activeDirectoryName()

      The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.

      Returns:
      The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.

    • realm

      public final String realm()

      The realm of the Active Directory that is associated with your Quick Sight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.

      Returns:
      The realm of the Active Directory that is associated with your Quick Sight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight account.

    • directoryId

      public final String directoryId()

      The ID of the Active Directory that is associated with your Quick Sight account.

      Returns:
      The ID of the Active Directory that is associated with your Quick Sight account.

    • hasAdminGroup

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

    • adminGroup

      public final List<String> adminGroup()

      The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

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

      Returns:
      The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

    • hasAuthorGroup

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

    • authorGroup

      public final List<String> authorGroup()

      The author group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

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

      Returns:
      The author group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

    • hasReaderGroup

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

    • readerGroup

      public final List<String> readerGroup()

      The reader group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

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

      Returns:
      The reader group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

    • hasAdminProGroup

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

    • adminProGroup

      public final List<String> adminProGroup()

      The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

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

      Returns:
      The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

    • hasAuthorProGroup

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

    • authorProGroup

      public final List<String> authorProGroup()

      The author pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

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

      Returns:
      The author pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

    • hasReaderProGroup

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

    • readerProGroup

      public final List<String> readerProGroup()

      The reader pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

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

      Returns:
      The reader pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

    • firstName

      public final String firstName()

      The first name of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

      Returns:
      The first name of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

    • lastName

      public final String lastName()

      The last name of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

      Returns:
      The last name of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

    • emailAddress

      public final String emailAddress()

      The email address of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

      Returns:
      The email address of the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

    • contactNumber

      public final String contactNumber()

      A 10-digit phone number for the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

      Returns:
      A 10-digit phone number for the author of the Amazon Quick Sight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon Quick Sight account.

    • iamIdentityCenterInstanceArn

      public final String iamIdentityCenterInstanceArn()

      The Amazon Resource Name (ARN) for the IAM Identity Center instance.

      Returns:
      The Amazon Resource Name (ARN) for the IAM Identity Center instance.

    • toBuilder

      public CreateAccountSubscriptionRequest.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<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAccountSubscriptionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAccountSubscriptionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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