software.amazon.awssdk.services.quicksight.model

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(value="software.amazon.awssdk:codegen")
public final class CreateAccountSubscriptionRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAccountSubscriptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountName() The name of your Amazon QuickSight account.
String	activeDirectoryName() The name of your Active Directory.
List<String>	adminGroup() The admin group associated with your Active Directory.
AuthenticationMethodOption	authenticationMethod() The method that you want to use to authenticate your Amazon QuickSight account.
String	authenticationMethodAsString() The method that you want to use to authenticate your Amazon QuickSight account.
List<String>	authorGroup() The author group associated with your Active Directory.
String	awsAccountId() The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
static CreateAccountSubscriptionRequest.Builder	builder()
String	contactNumber() A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications.
String	directoryId() The ID of the Active Directory that is associated with your Amazon QuickSight account.
Edition	edition() The edition of Amazon QuickSight that you want your account to have.
String	editionAsString() The edition of Amazon QuickSight that you want your account to have.
String	emailAddress() The email address of the author of the Amazon QuickSight account to use for future communications.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName() The first name of the author of the Amazon QuickSight account to use for future communications.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdminGroup() For responses, this returns true if the service returned a value for the AdminGroup property.
boolean	hasAuthorGroup() For responses, this returns true if the service returned a value for the AuthorGroup property.
int	hashCode()
boolean	hasReaderGroup() For responses, this returns true if the service returned a value for the ReaderGroup property.
String	lastName() The last name of the author of the Amazon QuickSight account to use for future communications.
String	notificationEmail() The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
List<String>	readerGroup() The reader group associated with your Active Direcrtory.
String	realm() The realm of the Active Directory that is associated with your Amazon QuickSight account.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccountSubscriptionRequest.Builder>	serializableBuilderClass()
CreateAccountSubscriptionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

edition

public final Edition edition()

The edition of Amazon QuickSight 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 QuickSight 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:

Edition

editionAsString

public final String editionAsString()

The edition of Amazon QuickSight 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 QuickSight 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:

Edition

authenticationMethod

public final AuthenticationMethodOption authenticationMethod()

The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

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

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 Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

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

See Also:

AuthenticationMethodOption

authenticationMethodAsString

public final String authenticationMethodAsString()

The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

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

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 Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

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

See Also:

AuthenticationMethodOption

awsAccountId

public final String awsAccountId()

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

Returns:

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

accountName

public final String accountName()

The name of your Amazon QuickSight 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 QuickSight account is created.

Returns:

The name of your Amazon QuickSight 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 QuickSight account is created.

notificationEmail

public final String notificationEmail()

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

Returns:

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight 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 Amazon QuickSight account.

Returns:

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

realm

public final String realm()

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

Returns:

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

directoryId

public final String directoryId()

The ID of the Active Directory that is associated with your Amazon QuickSight account.

Returns:

The ID of the Active Directory that is associated with your Amazon QuickSight 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. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight 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. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight 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. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight 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. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight 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 Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight 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 Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

firstName

public final String firstName()

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

Returns:

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

lastName

public final String lastName()

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

Returns:

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

emailAddress

public final String emailAddress()

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

Returns:

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

contactNumber

public final String contactNumber()

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

Returns:

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

toBuilder

public CreateAccountSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>

Specified by:

toBuilder in class QuickSightRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo