Class ClientCredentialsProperties
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.ClientCredentialsProperties
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ClientCredentialsProperties.Builder,ClientCredentialsProperties>
@Generated("software.amazon.awssdk:codegen") public final class ClientCredentialsProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClientCredentialsProperties.Builder,ClientCredentialsProperties>
OAuth2 client credentials configuration that defines the properties needed for the Client Credentials grant type flow.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceClientCredentialsProperties.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClientCredentialsProperties.Builderbuilder()ConnectorPropertyclientId()The OAuth2 client identifier provided by the authorization server.ConnectorPropertyclientSecret()The OAuth2 client secret provided by the authorization server.ContentTypecontentType()The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.StringcontentTypeAsString()The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTokenUrlParameters()For responses, this returns true if the service returned a value for the TokenUrlParameters property.HTTPMethodrequestMethod()The HTTP method to use when making token requests, typically POST.StringrequestMethodAsString()The HTTP method to use when making token requests, typically POST.ConnectorPropertyscope()The OAuth2 scope that defines the level of access requested for the client credentials flow.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ClientCredentialsProperties.Builder>serializableBuilderClass()ClientCredentialsProperties.BuildertoBuilder()ConnectorPropertytokenUrl()The token endpoint URL where the client will request access tokens using client credentials.List<ConnectorProperty>tokenUrlParameters()Additional parameters to include in token URL requests as key-value pairs.StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
tokenUrl
public final ConnectorProperty tokenUrl()
The token endpoint URL where the client will request access tokens using client credentials.
- Returns:
- The token endpoint URL where the client will request access tokens using client credentials.
-
requestMethod
public final HTTPMethod requestMethod()
The HTTP method to use when making token requests, typically POST.
If the service returns an enum value that is not available in the current SDK version,
requestMethodwill returnHTTPMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrequestMethodAsString().- Returns:
- The HTTP method to use when making token requests, typically POST.
- See Also:
HTTPMethod
-
requestMethodAsString
public final String requestMethodAsString()
The HTTP method to use when making token requests, typically POST.
If the service returns an enum value that is not available in the current SDK version,
requestMethodwill returnHTTPMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrequestMethodAsString().- Returns:
- The HTTP method to use when making token requests, typically POST.
- See Also:
HTTPMethod
-
contentType
public final ContentType contentType()
The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
If the service returns an enum value that is not available in the current SDK version,
contentTypewill returnContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontentTypeAsString().- Returns:
- The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
- See Also:
ContentType
-
contentTypeAsString
public final String contentTypeAsString()
The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
If the service returns an enum value that is not available in the current SDK version,
contentTypewill returnContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontentTypeAsString().- Returns:
- The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
- See Also:
ContentType
-
clientId
public final ConnectorProperty clientId()
The OAuth2 client identifier provided by the authorization server.
- Returns:
- The OAuth2 client identifier provided by the authorization server.
-
clientSecret
public final ConnectorProperty clientSecret()
The OAuth2 client secret provided by the authorization server.
- Returns:
- The OAuth2 client secret provided by the authorization server.
-
scope
public final ConnectorProperty scope()
The OAuth2 scope that defines the level of access requested for the client credentials flow.
- Returns:
- The OAuth2 scope that defines the level of access requested for the client credentials flow.
-
hasTokenUrlParameters
public final boolean hasTokenUrlParameters()
For responses, this returns true if the service returned a value for the TokenUrlParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tokenUrlParameters
public final List<ConnectorProperty> tokenUrlParameters()
Additional parameters to include in token URL requests as key-value pairs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTokenUrlParameters()method.- Returns:
- Additional parameters to include in token URL requests as key-value pairs.
-
toBuilder
public ClientCredentialsProperties.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ClientCredentialsProperties.Builder,ClientCredentialsProperties>
-
builder
public static ClientCredentialsProperties.Builder builder()
-
serializableBuilderClass
public static Class<? extends ClientCredentialsProperties.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-