Interface ClientCredentialsProperties.Builder

All Superinterfaces:

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

Enclosing class:

ClientCredentialsProperties

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

Method Summary

Modifier and Type	Method	Description
default ClientCredentialsProperties.Builder	clientId(Consumer<ConnectorProperty.Builder> clientId)	The OAuth2 client identifier provided by the authorization server.
ClientCredentialsProperties.Builder	clientId(ConnectorProperty clientId)	The OAuth2 client identifier provided by the authorization server.
default ClientCredentialsProperties.Builder	clientSecret(Consumer<ConnectorProperty.Builder> clientSecret)	The OAuth2 client secret provided by the authorization server.
ClientCredentialsProperties.Builder	clientSecret(ConnectorProperty clientSecret)	The OAuth2 client secret provided by the authorization server.
ClientCredentialsProperties.Builder	contentType(String contentType)	The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
ClientCredentialsProperties.Builder	contentType(ContentType contentType)	The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
ClientCredentialsProperties.Builder	requestMethod(String requestMethod)	The HTTP method to use when making token requests, typically POST.
ClientCredentialsProperties.Builder	requestMethod(HTTPMethod requestMethod)	The HTTP method to use when making token requests, typically POST.
default ClientCredentialsProperties.Builder	scope(Consumer<ConnectorProperty.Builder> scope)	The OAuth2 scope that defines the level of access requested for the client credentials flow.
ClientCredentialsProperties.Builder	scope(ConnectorProperty scope)	The OAuth2 scope that defines the level of access requested for the client credentials flow.
default ClientCredentialsProperties.Builder	tokenUrl(Consumer<ConnectorProperty.Builder> tokenUrl)	The token endpoint URL where the client will request access tokens using client credentials.
ClientCredentialsProperties.Builder	tokenUrl(ConnectorProperty tokenUrl)	The token endpoint URL where the client will request access tokens using client credentials.
ClientCredentialsProperties.Builder	tokenUrlParameters(Collection<ConnectorProperty> tokenUrlParameters)	Additional parameters to include in token URL requests as key-value pairs.
ClientCredentialsProperties.Builder	tokenUrlParameters(Consumer<ConnectorProperty.Builder>... tokenUrlParameters)	Additional parameters to include in token URL requests as key-value pairs.
ClientCredentialsProperties.Builder	tokenUrlParameters(ConnectorProperty... tokenUrlParameters)	Additional parameters to include in token URL requests as key-value pairs.

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

tokenUrl

ClientCredentialsProperties.Builder tokenUrl(ConnectorProperty tokenUrl)

The token endpoint URL where the client will request access tokens using client credentials.

Parameters:

tokenUrl - The token endpoint URL where the client will request access tokens using client credentials.

Returns:

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

tokenUrl

default ClientCredentialsProperties.Builder tokenUrl(Consumer<ConnectorProperty.Builder> tokenUrl)

The token endpoint URL where the client will request access tokens using client credentials.

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

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

Parameters:

tokenUrl - a consumer that will call methods on ConnectorProperty.Builder

Returns:

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

See Also:

• tokenUrl(ConnectorProperty)

requestMethod

ClientCredentialsProperties.Builder requestMethod(String requestMethod)

The HTTP method to use when making token requests, typically POST.

Parameters:

requestMethod - The HTTP method to use when making token requests, typically POST.

Returns:

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

See Also:

• HTTPMethod
• HTTPMethod

requestMethod

ClientCredentialsProperties.Builder requestMethod(HTTPMethod requestMethod)

The HTTP method to use when making token requests, typically POST.

Parameters:

requestMethod - The HTTP method to use when making token requests, typically POST.

Returns:

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

See Also:

• HTTPMethod
• HTTPMethod

contentType

ClientCredentialsProperties.Builder contentType(String contentType)

The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.

Parameters:

contentType - The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.

Returns:

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

See Also:

• ContentType
• ContentType

contentType

ClientCredentialsProperties.Builder contentType(ContentType contentType)

The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.

Parameters:

contentType - The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.

Returns:

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

See Also:

• ContentType
• ContentType

clientId

ClientCredentialsProperties.Builder clientId(ConnectorProperty clientId)

The OAuth2 client identifier provided by the authorization server.

Parameters:

clientId - The OAuth2 client identifier provided by the authorization server.

Returns:

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

clientId

default ClientCredentialsProperties.Builder clientId(Consumer<ConnectorProperty.Builder> clientId)

The OAuth2 client identifier provided by the authorization server.

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

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

Parameters:

clientId - a consumer that will call methods on ConnectorProperty.Builder

Returns:

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

See Also:

• clientId(ConnectorProperty)

clientSecret

ClientCredentialsProperties.Builder clientSecret(ConnectorProperty clientSecret)

The OAuth2 client secret provided by the authorization server.

Parameters:

clientSecret - The OAuth2 client secret provided by the authorization server.

Returns:

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

clientSecret

default ClientCredentialsProperties.Builder clientSecret(Consumer<ConnectorProperty.Builder> clientSecret)

The OAuth2 client secret provided by the authorization server.

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

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

Parameters:

clientSecret - a consumer that will call methods on ConnectorProperty.Builder

Returns:

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

See Also:

• clientSecret(ConnectorProperty)

scope

ClientCredentialsProperties.Builder scope(ConnectorProperty scope)

The OAuth2 scope that defines the level of access requested for the client credentials flow.

Parameters:

scope - The OAuth2 scope that defines the level of access requested for the client credentials flow.

Returns:

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

scope

default ClientCredentialsProperties.Builder scope(Consumer<ConnectorProperty.Builder> scope)

The OAuth2 scope that defines the level of access requested for the client credentials flow.

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

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

Parameters:

scope - a consumer that will call methods on ConnectorProperty.Builder

Returns:

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

See Also:

• scope(ConnectorProperty)

tokenUrlParameters

ClientCredentialsProperties.Builder tokenUrlParameters(Collection<ConnectorProperty> tokenUrlParameters)

Additional parameters to include in token URL requests as key-value pairs.

Parameters:

tokenUrlParameters - Additional parameters to include in token URL requests as key-value pairs.

Returns:

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

tokenUrlParameters

ClientCredentialsProperties.Builder tokenUrlParameters(ConnectorProperty... tokenUrlParameters)

Additional parameters to include in token URL requests as key-value pairs.

Parameters:

tokenUrlParameters - Additional parameters to include in token URL requests as key-value pairs.

Returns:

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

tokenUrlParameters

ClientCredentialsProperties.Builder tokenUrlParameters(Consumer<ConnectorProperty.Builder>... tokenUrlParameters)

Additional parameters to include in token URL requests as key-value pairs.

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

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

Parameters:

tokenUrlParameters - a consumer that will call methods on ConnectorProperty.Builder

Returns:

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

See Also:

• tokenUrlParameters(java.util.Collection<ConnectorProperty>)