Class CreateAccessControlApplicationRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateAccessControlApplicationRequest.Builder,CreateAccessControlApplicationRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe ID for the access control application.The authentication protocol that the access control application uses.final StringThe authentication protocol that the access control application uses.final StringThe ID of the Amazon Web Services account that contains the Quick Sight account.builder()final StringThe description of the access control application.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.The identity provider configuration of the access control application.final Stringname()The name of the access control application.final StringThe Quick Sight namespace for the access control application.The Quick Sight authentication configuration of the access control application.static Class<? extends CreateAccessControlApplicationRequest.Builder> tags()The tags to assign to the access control application.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
awsAccountId
The ID of the Amazon Web Services account that contains the Quick Sight account.
- Returns:
- The ID of the Amazon Web Services account that contains the Quick Sight account.
-
applicationId
The ID for the access control application. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Quick Sight reserves IDs that start with
quick-aca-for the access control application of the Quick Sight desktop application. To create one, the ID must bequick-aca-followed by your Amazon Web Services account ID and the namespace, separated by a hyphen. For example,quick-aca-111122223333-default. In addition,QuickAuthenticationTypemust beQUICK_MANAGED_PUBLIC_AUTH_CODEwithhttp://localhost:18080as the only redirect URI, andIdpAuthorizingTypemust beIDC_AUTH_CODEorQUICK_MANAGED_AUTH_CODE.- Returns:
- The ID for the access control application. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
Quick Sight reserves IDs that start with
quick-aca-for the access control application of the Quick Sight desktop application. To create one, the ID must bequick-aca-followed by your Amazon Web Services account ID and the namespace, separated by a hyphen. For example,quick-aca-111122223333-default. In addition,QuickAuthenticationTypemust beQUICK_MANAGED_PUBLIC_AUTH_CODEwithhttp://localhost:18080as the only redirect URI, andIdpAuthorizingTypemust beIDC_AUTH_CODEorQUICK_MANAGED_AUTH_CODE.
-
name
The name of the access control application.
- Returns:
- The name of the access control application.
-
description
The description of the access control application.
- Returns:
- The description of the access control application.
-
namespace
The Quick Sight namespace for the access control application.
- Returns:
- The Quick Sight namespace for the access control application.
-
authenticationType
The authentication protocol that the access control application uses.
If the service returns an enum value that is not available in the current SDK version,
authenticationTypewill returnAccessControlApplicationAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationTypeAsString().- Returns:
- The authentication protocol that the access control application uses.
- See Also:
-
authenticationTypeAsString
The authentication protocol that the access control application uses.
If the service returns an enum value that is not available in the current SDK version,
authenticationTypewill returnAccessControlApplicationAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationTypeAsString().- Returns:
- The authentication protocol that the access control application uses.
- See Also:
-
idpAuthorizingConfiguration
The identity provider configuration of the access control application.
- Returns:
- The identity provider configuration of the access control application.
-
quickAuthenticationConfiguration
The Quick Sight authentication configuration of the access control application. You provide redirect URIs, and Quick Sight generates the client ID.
- Returns:
- The Quick Sight authentication configuration of the access control application. You provide redirect URIs, and Quick Sight generates the client ID.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
tags
The tags to assign to the access control application.
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
hasTags()method.- Returns:
- The tags to assign to the access control application.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateAccessControlApplicationRequest.Builder,CreateAccessControlApplicationRequest> - Specified by:
toBuilderin classQuickSightRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateAccessControlApplicationRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-