Interface ClientCredentialsProperties.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<ClientCredentialsProperties.Builder,,ClientCredentialsProperties> SdkBuilder<ClientCredentialsProperties.Builder,,ClientCredentialsProperties> SdkPojo
- Enclosing class:
ClientCredentialsProperties
-
Method Summary
Modifier and TypeMethodDescriptionclientId(Consumer<ConnectorProperty.Builder> clientId) The OAuth2 client identifier provided by the authorization server.clientId(ConnectorProperty clientId) The OAuth2 client identifier provided by the authorization server.clientSecret(Consumer<ConnectorProperty.Builder> clientSecret) The OAuth2 client secret provided by the authorization server.clientSecret(ConnectorProperty clientSecret) The OAuth2 client secret provided by the authorization server.contentType(String contentType) The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.contentType(ContentType contentType) The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.requestMethod(String requestMethod) The HTTP method to use when making token requests, typically POST.requestMethod(HTTPMethod requestMethod) The HTTP method to use when making token requests, typically POST.scope(Consumer<ConnectorProperty.Builder> scope) The OAuth2 scope that defines the level of access requested for the client credentials flow.scope(ConnectorProperty scope) The OAuth2 scope that defines the level of access requested for the client credentials flow.tokenUrl(Consumer<ConnectorProperty.Builder> tokenUrl) The token endpoint URL where the client will request access tokens using client credentials.tokenUrl(ConnectorProperty tokenUrl) The token endpoint URL where the client will request access tokens using client credentials.tokenUrlParameters(Collection<ConnectorProperty> tokenUrlParameters) Additional parameters to include in token URL requests as key-value pairs.tokenUrlParameters(Consumer<ConnectorProperty.Builder>... tokenUrlParameters) Additional parameters to include in token URL requests as key-value pairs.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
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
The token endpoint URL where the client will request access tokens using client credentials.
This is a convenience method that creates an instance of theConnectorProperty.Builderavoiding the need to create one manually viaConnectorProperty.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totokenUrl(ConnectorProperty).- Parameters:
tokenUrl- a consumer that will call methods onConnectorProperty.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
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
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:
-
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
The OAuth2 client identifier provided by the authorization server.
This is a convenience method that creates an instance of theConnectorProperty.Builderavoiding the need to create one manually viaConnectorProperty.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toclientId(ConnectorProperty).- Parameters:
clientId- a consumer that will call methods onConnectorProperty.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theConnectorProperty.Builderavoiding the need to create one manually viaConnectorProperty.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toclientSecret(ConnectorProperty).- Parameters:
clientSecret- a consumer that will call methods onConnectorProperty.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theConnectorProperty.Builderavoiding the need to create one manually viaConnectorProperty.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toscope(ConnectorProperty).- Parameters:
scope- a consumer that will call methods onConnectorProperty.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theConnectorProperty.Builderavoiding the need to create one manually viaConnectorProperty.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totokenUrlParameters(List<ConnectorProperty>).- Parameters:
tokenUrlParameters- a consumer that will call methods onConnectorProperty.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-