Interface OAuth2PropertiesInput.Builder

All Superinterfaces:

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

Enclosing class:

OAuth2PropertiesInput

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

Method Summary

Modifier and Type	Method	Description
default OAuth2PropertiesInput.Builder	authorizationCodeProperties(Consumer<AuthorizationCodeProperties.Builder> authorizationCodeProperties)	The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.
OAuth2PropertiesInput.Builder	authorizationCodeProperties(AuthorizationCodeProperties authorizationCodeProperties)	The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.
default OAuth2PropertiesInput.Builder	oAuth2ClientApplication(Consumer<OAuth2ClientApplication.Builder> oAuth2ClientApplication)	The client application type in the CreateConnection request.
OAuth2PropertiesInput.Builder	oAuth2ClientApplication(OAuth2ClientApplication oAuth2ClientApplication)	The client application type in the CreateConnection request.
default OAuth2PropertiesInput.Builder	oAuth2Credentials(Consumer<OAuth2Credentials.Builder> oAuth2Credentials)	The credentials used when the authentication type is OAuth2 authentication.
OAuth2PropertiesInput.Builder	oAuth2Credentials(OAuth2Credentials oAuth2Credentials)	The credentials used when the authentication type is OAuth2 authentication.
OAuth2PropertiesInput.Builder	oAuth2GrantType(String oAuth2GrantType)	The OAuth2 grant type in the CreateConnection request.
OAuth2PropertiesInput.Builder	oAuth2GrantType(OAuth2GrantType oAuth2GrantType)	The OAuth2 grant type in the CreateConnection request.
OAuth2PropertiesInput.Builder	tokenUrl(String tokenUrl)	The URL of the provider's authentication server, to exchange an authorization code for an access token.
OAuth2PropertiesInput.Builder	tokenUrlParametersMap(Map<String,String> tokenUrlParametersMap)	A map of parameters that are added to the token GET request.

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

oAuth2GrantType

OAuth2PropertiesInput.Builder oAuth2GrantType(String oAuth2GrantType)

The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

Parameters:

oAuth2GrantType - The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

Returns:

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

See Also:

• OAuth2GrantType
• OAuth2GrantType

oAuth2GrantType

OAuth2PropertiesInput.Builder oAuth2GrantType(OAuth2GrantType oAuth2GrantType)

The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

Parameters:

oAuth2GrantType - The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

Returns:

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

See Also:

• OAuth2GrantType
• OAuth2GrantType

oAuth2ClientApplication

OAuth2PropertiesInput.Builder oAuth2ClientApplication(OAuth2ClientApplication oAuth2ClientApplication)

The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED.

Parameters:

oAuth2ClientApplication - The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED.

Returns:

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

oAuth2ClientApplication

default OAuth2PropertiesInput.Builder oAuth2ClientApplication(Consumer<OAuth2ClientApplication.Builder> oAuth2ClientApplication)

The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED.

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

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

Parameters:

oAuth2ClientApplication - a consumer that will call methods on OAuth2ClientApplication.Builder

Returns:

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

See Also:

• oAuth2ClientApplication(OAuth2ClientApplication)

tokenUrl

OAuth2PropertiesInput.Builder tokenUrl(String tokenUrl)

The URL of the provider's authentication server, to exchange an authorization code for an access token.

Parameters:

tokenUrl - The URL of the provider's authentication server, to exchange an authorization code for an access token.

Returns:

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

tokenUrlParametersMap

OAuth2PropertiesInput.Builder tokenUrlParametersMap(Map<String,String> tokenUrlParametersMap)

A map of parameters that are added to the token GET request.

Parameters:

tokenUrlParametersMap - A map of parameters that are added to the token GET request.

Returns:

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

authorizationCodeProperties

OAuth2PropertiesInput.Builder authorizationCodeProperties(AuthorizationCodeProperties authorizationCodeProperties)

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

Parameters:

authorizationCodeProperties - The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

Returns:

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

authorizationCodeProperties

default OAuth2PropertiesInput.Builder authorizationCodeProperties(Consumer<AuthorizationCodeProperties.Builder> authorizationCodeProperties)

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

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

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

Parameters:

authorizationCodeProperties - a consumer that will call methods on AuthorizationCodeProperties.Builder

Returns:

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

See Also:

• authorizationCodeProperties(AuthorizationCodeProperties)

oAuth2Credentials

OAuth2PropertiesInput.Builder oAuth2Credentials(OAuth2Credentials oAuth2Credentials)

The credentials used when the authentication type is OAuth2 authentication.

Parameters:

oAuth2Credentials - The credentials used when the authentication type is OAuth2 authentication.

Returns:

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

oAuth2Credentials

default OAuth2PropertiesInput.Builder oAuth2Credentials(Consumer<OAuth2Credentials.Builder> oAuth2Credentials)

The credentials used when the authentication type is OAuth2 authentication.

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 oAuth2Credentials(OAuth2Credentials).

Parameters:

oAuth2Credentials - 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:

• oAuth2Credentials(OAuth2Credentials)