Interface ReadAuthConfig.Builder

All Superinterfaces:

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

Enclosing class:

ReadAuthConfig

@Mutable
@NotThreadSafe
public static interface ReadAuthConfig.Builder
extends SdkPojo, CopyableBuilder<ReadAuthConfig.Builder,ReadAuthConfig>

Method Summary

Modifier and Type	Method	Description
default ReadAuthConfig.Builder	authenticationMetadata(Consumer<ReadAuthenticationMetadata.Builder> authenticationMetadata)	The authentication metadata containing configuration details specific to the authentication type.
ReadAuthConfig.Builder	authenticationMetadata(ReadAuthenticationMetadata authenticationMetadata)	The authentication metadata containing configuration details specific to the authentication type.
ReadAuthConfig.Builder	authenticationType(String authenticationType)	The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).
ReadAuthConfig.Builder	authenticationType(ConnectionAuthType authenticationType)	The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

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, sdkFieldNameToField, sdkFields

Method Details

authenticationType

ReadAuthConfig.Builder authenticationType(String authenticationType)

The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

Parameters:

authenticationType - The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

Returns:

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

See Also:

• ConnectionAuthType
• ConnectionAuthType

authenticationType

ReadAuthConfig.Builder authenticationType(ConnectionAuthType authenticationType)

The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

Parameters:

authenticationType - The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

Returns:

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

See Also:

• ConnectionAuthType
• ConnectionAuthType

authenticationMetadata

ReadAuthConfig.Builder authenticationMetadata(ReadAuthenticationMetadata authenticationMetadata)

The authentication metadata containing configuration details specific to the authentication type.

Parameters:

authenticationMetadata - The authentication metadata containing configuration details specific to the authentication type.

Returns:

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

authenticationMetadata

default ReadAuthConfig.Builder authenticationMetadata(Consumer<ReadAuthenticationMetadata.Builder> authenticationMetadata)

The authentication metadata containing configuration details specific to the authentication type.

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

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

Parameters:

authenticationMetadata - a consumer that will call methods on ReadAuthenticationMetadata.Builder

Returns:

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

See Also:

• authenticationMetadata(ReadAuthenticationMetadata)