Interface CustomConnectorProfileCredentials.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CustomConnectorProfileCredentials.Builder,CustomConnectorProfileCredentials>, SdkBuilder<CustomConnectorProfileCredentials.Builder,CustomConnectorProfileCredentials>, SdkPojo

Enclosing class:

CustomConnectorProfileCredentials

public static interface CustomConnectorProfileCredentials.Builder
extends SdkPojo, CopyableBuilder<CustomConnectorProfileCredentials.Builder,CustomConnectorProfileCredentials>

Method Summary

Modifier and Type	Method	Description
default CustomConnectorProfileCredentials.Builder	apiKey(Consumer<ApiKeyCredentials.Builder> apiKey)	The API keys required for the authentication of the user.
CustomConnectorProfileCredentials.Builder	apiKey(ApiKeyCredentials apiKey)	The API keys required for the authentication of the user.
CustomConnectorProfileCredentials.Builder	authenticationType(String authenticationType)	The authentication type that the custom connector uses for authenticating while creating a connector profile.
CustomConnectorProfileCredentials.Builder	authenticationType(AuthenticationType authenticationType)	The authentication type that the custom connector uses for authenticating while creating a connector profile.
default CustomConnectorProfileCredentials.Builder	basic(Consumer<BasicAuthCredentials.Builder> basic)	The basic credentials that are required for the authentication of the user.
CustomConnectorProfileCredentials.Builder	basic(BasicAuthCredentials basic)	The basic credentials that are required for the authentication of the user.
default CustomConnectorProfileCredentials.Builder	custom(Consumer<CustomAuthCredentials.Builder> custom)	If the connector uses the custom authentication mechanism, this holds the required credentials.
CustomConnectorProfileCredentials.Builder	custom(CustomAuthCredentials custom)	If the connector uses the custom authentication mechanism, this holds the required credentials.
default CustomConnectorProfileCredentials.Builder	oauth2(Consumer<OAuth2Credentials.Builder> oauth2)	The OAuth 2.0 credentials required for the authentication of the user.
CustomConnectorProfileCredentials.Builder	oauth2(OAuth2Credentials oauth2)	The OAuth 2.0 credentials required for the authentication of the user.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

authenticationType

CustomConnectorProfileCredentials.Builder authenticationType(String authenticationType)

The authentication type that the custom connector uses for authenticating while creating a connector profile.

Parameters:

authenticationType - The authentication type that the custom connector uses for authenticating while creating a connector profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AuthenticationType
• AuthenticationType

authenticationType

CustomConnectorProfileCredentials.Builder authenticationType(AuthenticationType authenticationType)

The authentication type that the custom connector uses for authenticating while creating a connector profile.

Parameters:

authenticationType - The authentication type that the custom connector uses for authenticating while creating a connector profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AuthenticationType
• AuthenticationType

basic

CustomConnectorProfileCredentials.Builder basic(BasicAuthCredentials basic)

The basic credentials that are required for the authentication of the user.

Parameters:

basic - The basic credentials that are required for the authentication of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

basic

default CustomConnectorProfileCredentials.Builder basic(Consumer<BasicAuthCredentials.Builder> basic)

The basic credentials that are required for the authentication of the user.

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

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

Parameters:

basic - a consumer that will call methods on BasicAuthCredentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• basic(BasicAuthCredentials)

oauth2

CustomConnectorProfileCredentials.Builder oauth2(OAuth2Credentials oauth2)

The OAuth 2.0 credentials required for the authentication of the user.

Parameters:

oauth2 - The OAuth 2.0 credentials required for the authentication of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

oauth2

default CustomConnectorProfileCredentials.Builder oauth2(Consumer<OAuth2Credentials.Builder> oauth2)

The OAuth 2.0 credentials required for the authentication of the user.

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

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

Parameters:

oauth2 - a consumer that will call methods on OAuth2Credentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• oauth2(OAuth2Credentials)

apiKey

CustomConnectorProfileCredentials.Builder apiKey(ApiKeyCredentials apiKey)

The API keys required for the authentication of the user.

Parameters:

apiKey - The API keys required for the authentication of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiKey

default CustomConnectorProfileCredentials.Builder apiKey(Consumer<ApiKeyCredentials.Builder> apiKey)

The API keys required for the authentication of the user.

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

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

Parameters:

apiKey - a consumer that will call methods on ApiKeyCredentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• apiKey(ApiKeyCredentials)

custom

CustomConnectorProfileCredentials.Builder custom(CustomAuthCredentials custom)

If the connector uses the custom authentication mechanism, this holds the required credentials.

Parameters:

custom - If the connector uses the custom authentication mechanism, this holds the required credentials.

Returns:

Returns a reference to this object so that method calls can be chained together.

custom

default CustomConnectorProfileCredentials.Builder custom(Consumer<CustomAuthCredentials.Builder> custom)

If the connector uses the custom authentication mechanism, this holds the required credentials.

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

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

Parameters:

custom - a consumer that will call methods on CustomAuthCredentials.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• custom(CustomAuthCredentials)