Interface ConnectorAuthorizationCodeProperties.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ConnectorAuthorizationCodeProperties.Builder,ConnectorAuthorizationCodeProperties>,SdkBuilder<ConnectorAuthorizationCodeProperties.Builder,ConnectorAuthorizationCodeProperties>,SdkPojo
- Enclosing class:
- ConnectorAuthorizationCodeProperties
@Mutable @NotThreadSafe public static interface ConnectorAuthorizationCodeProperties.Builder extends SdkPojo, CopyableBuilder<ConnectorAuthorizationCodeProperties.Builder,ConnectorAuthorizationCodeProperties>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ConnectorAuthorizationCodeProperties.BuilderauthorizationCode(Consumer<ConnectorProperty.Builder> authorizationCode)The authorization code received from the authorization server after user consent.ConnectorAuthorizationCodeProperties.BuilderauthorizationCode(ConnectorProperty authorizationCode)The authorization code received from the authorization server after user consent.default ConnectorAuthorizationCodeProperties.BuilderauthorizationCodeUrl(Consumer<ConnectorProperty.Builder> authorizationCodeUrl)The authorization endpoint URL where users will be redirected to grant authorization.ConnectorAuthorizationCodeProperties.BuilderauthorizationCodeUrl(ConnectorProperty authorizationCodeUrl)The authorization endpoint URL where users will be redirected to grant authorization.default ConnectorAuthorizationCodeProperties.BuilderclientId(Consumer<ConnectorProperty.Builder> clientId)The OAuth2 client identifier provided by the authorization server.ConnectorAuthorizationCodeProperties.BuilderclientId(ConnectorProperty clientId)The OAuth2 client identifier provided by the authorization server.default ConnectorAuthorizationCodeProperties.BuilderclientSecret(Consumer<ConnectorProperty.Builder> clientSecret)The OAuth2 client secret provided by the authorization server.ConnectorAuthorizationCodeProperties.BuilderclientSecret(ConnectorProperty clientSecret)The OAuth2 client secret provided by the authorization server.ConnectorAuthorizationCodeProperties.BuildercontentType(String contentType)The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.ConnectorAuthorizationCodeProperties.BuildercontentType(ContentType contentType)The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.default ConnectorAuthorizationCodeProperties.Builderprompt(Consumer<ConnectorProperty.Builder> prompt)The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.ConnectorAuthorizationCodeProperties.Builderprompt(ConnectorProperty prompt)The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.default ConnectorAuthorizationCodeProperties.BuilderredirectUri(Consumer<ConnectorProperty.Builder> redirectUri)The redirect URI that must match the URI registered with the authorization server.ConnectorAuthorizationCodeProperties.BuilderredirectUri(ConnectorProperty redirectUri)The redirect URI that must match the URI registered with the authorization server.ConnectorAuthorizationCodeProperties.BuilderrequestMethod(String requestMethod)The HTTP method to use when making token exchange requests, typically POST.ConnectorAuthorizationCodeProperties.BuilderrequestMethod(HTTPMethod requestMethod)The HTTP method to use when making token exchange requests, typically POST.default ConnectorAuthorizationCodeProperties.Builderscope(Consumer<ConnectorProperty.Builder> scope)The OAuth2 scope that defines the level of access requested for the authorization code flow.ConnectorAuthorizationCodeProperties.Builderscope(ConnectorProperty scope)The OAuth2 scope that defines the level of access requested for the authorization code flow.default ConnectorAuthorizationCodeProperties.BuildertokenUrl(Consumer<ConnectorProperty.Builder> tokenUrl)The token endpoint URL where the authorization code will be exchanged for an access token.ConnectorAuthorizationCodeProperties.BuildertokenUrl(ConnectorProperty tokenUrl)The token endpoint URL where the authorization code will be exchanged for an access token.ConnectorAuthorizationCodeProperties.BuildertokenUrlParameters(Collection<ConnectorProperty> tokenUrlParameters)Additional parameters to include in token URL requests as key-value pairs.ConnectorAuthorizationCodeProperties.BuildertokenUrlParameters(Consumer<ConnectorProperty.Builder>... tokenUrlParameters)Additional parameters to include in token URL requests as key-value pairs.ConnectorAuthorizationCodeProperties.BuildertokenUrlParameters(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 Detail
-
authorizationCodeUrl
ConnectorAuthorizationCodeProperties.Builder authorizationCodeUrl(ConnectorProperty authorizationCodeUrl)
The authorization endpoint URL where users will be redirected to grant authorization.
- Parameters:
authorizationCodeUrl- The authorization endpoint URL where users will be redirected to grant authorization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizationCodeUrl
default ConnectorAuthorizationCodeProperties.Builder authorizationCodeUrl(Consumer<ConnectorProperty.Builder> authorizationCodeUrl)
The authorization endpoint URL where users will be redirected to grant authorization.
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 toauthorizationCodeUrl(ConnectorProperty).- Parameters:
authorizationCodeUrl- 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:
authorizationCodeUrl(ConnectorProperty)
-
authorizationCode
ConnectorAuthorizationCodeProperties.Builder authorizationCode(ConnectorProperty authorizationCode)
The authorization code received from the authorization server after user consent.
- Parameters:
authorizationCode- The authorization code received from the authorization server after user consent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizationCode
default ConnectorAuthorizationCodeProperties.Builder authorizationCode(Consumer<ConnectorProperty.Builder> authorizationCode)
The authorization code received from the authorization server after user consent.
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 toauthorizationCode(ConnectorProperty).- Parameters:
authorizationCode- 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:
authorizationCode(ConnectorProperty)
-
redirectUri
ConnectorAuthorizationCodeProperties.Builder redirectUri(ConnectorProperty redirectUri)
The redirect URI that must match the URI registered with the authorization server.
- Parameters:
redirectUri- The redirect URI that must match the URI registered with the authorization server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
redirectUri
default ConnectorAuthorizationCodeProperties.Builder redirectUri(Consumer<ConnectorProperty.Builder> redirectUri)
The redirect URI that must match the URI registered with 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 toredirectUri(ConnectorProperty).- Parameters:
redirectUri- 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:
redirectUri(ConnectorProperty)
-
tokenUrl
ConnectorAuthorizationCodeProperties.Builder tokenUrl(ConnectorProperty tokenUrl)
The token endpoint URL where the authorization code will be exchanged for an access token.
- Parameters:
tokenUrl- The token endpoint URL where the authorization code will be exchanged for an access token.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tokenUrl
default ConnectorAuthorizationCodeProperties.Builder tokenUrl(Consumer<ConnectorProperty.Builder> tokenUrl)
The token endpoint URL where the authorization code will be exchanged for an access token.
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:
tokenUrl(ConnectorProperty)
-
requestMethod
ConnectorAuthorizationCodeProperties.Builder requestMethod(String requestMethod)
The HTTP method to use when making token exchange requests, typically POST.
- Parameters:
requestMethod- The HTTP method to use when making token exchange requests, typically POST.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HTTPMethod,HTTPMethod
-
requestMethod
ConnectorAuthorizationCodeProperties.Builder requestMethod(HTTPMethod requestMethod)
The HTTP method to use when making token exchange requests, typically POST.
- Parameters:
requestMethod- The HTTP method to use when making token exchange requests, typically POST.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HTTPMethod,HTTPMethod
-
contentType
ConnectorAuthorizationCodeProperties.Builder contentType(String contentType)
The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
- Parameters:
contentType- The content type to use for token exchange 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
ConnectorAuthorizationCodeProperties.Builder contentType(ContentType contentType)
The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
- Parameters:
contentType- The content type to use for token exchange 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
ConnectorAuthorizationCodeProperties.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 ConnectorAuthorizationCodeProperties.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 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:
clientId(ConnectorProperty)
-
clientSecret
ConnectorAuthorizationCodeProperties.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 ConnectorAuthorizationCodeProperties.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:
clientSecret(ConnectorProperty)
-
scope
ConnectorAuthorizationCodeProperties.Builder scope(ConnectorProperty scope)
The OAuth2 scope that defines the level of access requested for the authorization code flow.
- Parameters:
scope- The OAuth2 scope that defines the level of access requested for the authorization code flow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scope
default ConnectorAuthorizationCodeProperties.Builder scope(Consumer<ConnectorProperty.Builder> scope)
The OAuth2 scope that defines the level of access requested for the authorization code 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:
scope(ConnectorProperty)
-
prompt
ConnectorAuthorizationCodeProperties.Builder prompt(ConnectorProperty prompt)
The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.
- Parameters:
prompt- The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
prompt
default ConnectorAuthorizationCodeProperties.Builder prompt(Consumer<ConnectorProperty.Builder> prompt)
The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.
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 toprompt(ConnectorProperty).- Parameters:
prompt- 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:
prompt(ConnectorProperty)
-
tokenUrlParameters
ConnectorAuthorizationCodeProperties.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
ConnectorAuthorizationCodeProperties.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
ConnectorAuthorizationCodeProperties.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 to#tokenUrlParameters(List.) - 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:
#tokenUrlParameters(java.util.Collection)
-
-