Interface OAuth2Properties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OAuth2Properties.Builder,OAuth2Properties>, SdkBuilder<OAuth2Properties.Builder,OAuth2Properties>, SdkPojo
Enclosing class:
OAuth2Properties
public static interface OAuth2Properties.Builder extends SdkPojo, CopyableBuilder<OAuth2Properties.Builder,OAuth2Properties>

  • Method Details

    • oAuth2GrantType

      OAuth2Properties.Builder oAuth2GrantType(String oAuth2GrantType)

      The OAuth2 grant type. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

      Parameters:
      oAuth2GrantType - The OAuth2 grant type. 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

      OAuth2Properties.Builder oAuth2GrantType(OAuth2GrantType oAuth2GrantType)

      The OAuth2 grant type. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

      Parameters:
      oAuth2GrantType - The OAuth2 grant type. 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:

    • oAuth2ClientApplication

      OAuth2Properties.Builder oAuth2ClientApplication(OAuth2ClientApplication oAuth2ClientApplication)

      The client application type. For example, AWS_MANAGED or USER_MANAGED.

      Parameters:
      oAuth2ClientApplication - The client application type. For example, AWS_MANAGED or USER_MANAGED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oAuth2ClientApplication

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

      The client application type. 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:

    • tokenUrl

      OAuth2Properties.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

      OAuth2Properties.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.