Interface CreateOAuthClientApplicationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateOAuthClientApplicationRequest.Builder,CreateOAuthClientApplicationRequest>, QuickSightRequest.Builder, SdkBuilder<CreateOAuthClientApplicationRequest.Builder,CreateOAuthClientApplicationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateOAuthClientApplicationRequest
@Mutable @NotThreadSafe public static interface CreateOAuthClientApplicationRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateOAuthClientApplicationRequest.Builder,CreateOAuthClientApplicationRequest>

  • Method Details

    • awsAccountId

      CreateOAuthClientApplicationRequest.Builder awsAccountId(String awsAccountId)

      The Amazon Web Services account ID.

      Parameters:
      awsAccountId - The Amazon Web Services account ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oAuthClientApplicationId

      CreateOAuthClientApplicationRequest.Builder oAuthClientApplicationId(String oAuthClientApplicationId)

      An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      Parameters:
      oAuthClientApplicationId - An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateOAuthClientApplicationRequest.Builder name(String name)

      The display name for the OAuthClientApplication.

      Parameters:
      name - The display name for the OAuthClientApplication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oAuthClientAuthenticationType

      CreateOAuthClientApplicationRequest.Builder oAuthClientAuthenticationType(String oAuthClientAuthenticationType)

      The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.

      Parameters:
      oAuthClientAuthenticationType - The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • oAuthClientAuthenticationType

      CreateOAuthClientApplicationRequest.Builder oAuthClientAuthenticationType(OAuthClientAuthenticationType oAuthClientAuthenticationType)

      The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.

      Parameters:
      oAuthClientAuthenticationType - The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientId

      CreateOAuthClientApplicationRequest.Builder clientId(String clientId)

      The client ID of the OAuth application that is registered with the identity provider.

      Parameters:
      clientId - The client ID of the OAuth application that is registered with the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecret

      CreateOAuthClientApplicationRequest.Builder clientSecret(String clientSecret)

      The client secret of the OAuth application that is registered with the identity provider.

      Parameters:
      clientSecret - The client secret of the OAuth application that is registered with the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oAuthTokenEndpointUrl

      CreateOAuthClientApplicationRequest.Builder oAuthTokenEndpointUrl(String oAuthTokenEndpointUrl)

      The token endpoint URL of the identity provider that is used to obtain access tokens.

      Parameters:
      oAuthTokenEndpointUrl - The token endpoint URL of the identity provider that is used to obtain access tokens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oAuthAuthorizationEndpointUrl

      CreateOAuthClientApplicationRequest.Builder oAuthAuthorizationEndpointUrl(String oAuthAuthorizationEndpointUrl)

      The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

      Parameters:
      oAuthAuthorizationEndpointUrl - The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oAuthScopes

      CreateOAuthClientApplicationRequest.Builder oAuthScopes(String oAuthScopes)

      The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

      Parameters:
      oAuthScopes - The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceType

      CreateOAuthClientApplicationRequest.Builder dataSourceType(String dataSourceType)

      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE .

      Parameters:
      dataSourceType - The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataSourceType

      CreateOAuthClientApplicationRequest.Builder dataSourceType(DataSourceType dataSourceType)

      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE .

      Parameters:
      dataSourceType - The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • identityProviderVpcConnectionProperties

      CreateOAuthClientApplicationRequest.Builder identityProviderVpcConnectionProperties(VpcConnectionProperties identityProviderVpcConnectionProperties)
      Sets the value of the IdentityProviderVpcConnectionProperties property for this object.
      Parameters:
      identityProviderVpcConnectionProperties - The new value for the IdentityProviderVpcConnectionProperties property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderVpcConnectionProperties

      default CreateOAuthClientApplicationRequest.Builder identityProviderVpcConnectionProperties(Consumer<VpcConnectionProperties.Builder> identityProviderVpcConnectionProperties)
      Sets the value of the IdentityProviderVpcConnectionProperties property for this object. This is a convenience method that creates an instance of the VpcConnectionProperties.Builder avoiding the need to create one manually via VpcConnectionProperties.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identityProviderVpcConnectionProperties(VpcConnectionProperties).

      Parameters:
      identityProviderVpcConnectionProperties - a consumer that will call methods on VpcConnectionProperties.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateOAuthClientApplicationRequest.Builder tags(Collection<Tag> tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateOAuthClientApplicationRequest.Builder tags(Tag... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateOAuthClientApplicationRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateOAuthClientApplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateOAuthClientApplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.