Class ConnectorAuthorizationCodeProperties

java.lang.Object
software.amazon.awssdk.services.glue.model.ConnectorAuthorizationCodeProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ConnectorAuthorizationCodeProperties.Builder,ConnectorAuthorizationCodeProperties>
@Generated("software.amazon.awssdk:codegen") public final class ConnectorAuthorizationCodeProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConnectorAuthorizationCodeProperties.Builder,ConnectorAuthorizationCodeProperties>

OAuth2 authorization code configuration that defines the properties needed for the Authorization Code grant type flow.

See Also:

  • Method Details

    • authorizationCodeUrl

      public final ConnectorProperty authorizationCodeUrl()

      The authorization endpoint URL where users will be redirected to grant authorization.

      Returns:
      The authorization endpoint URL where users will be redirected to grant authorization.

    • authorizationCode

      public final ConnectorProperty authorizationCode()

      The authorization code received from the authorization server after user consent.

      Returns:
      The authorization code received from the authorization server after user consent.

    • redirectUri

      public final ConnectorProperty redirectUri()

      The redirect URI that must match the URI registered with the authorization server.

      Returns:
      The redirect URI that must match the URI registered with the authorization server.

    • tokenUrl

      public final ConnectorProperty tokenUrl()

      The token endpoint URL where the authorization code will be exchanged for an access token.

      Returns:
      The token endpoint URL where the authorization code will be exchanged for an access token.

    • requestMethod

      public final HTTPMethod requestMethod()

      The HTTP method to use when making token exchange requests, typically POST.

      If the service returns an enum value that is not available in the current SDK version, requestMethod will return HTTPMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestMethodAsString().

      Returns:
      The HTTP method to use when making token exchange requests, typically POST.
      See Also:

    • requestMethodAsString

      public final String requestMethodAsString()

      The HTTP method to use when making token exchange requests, typically POST.

      If the service returns an enum value that is not available in the current SDK version, requestMethod will return HTTPMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestMethodAsString().

      Returns:
      The HTTP method to use when making token exchange requests, typically POST.
      See Also:

    • contentType

      public final ContentType contentType()

      The content type to use for token exchange 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, contentType will return ContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

      Returns:
      The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
      See Also:

    • contentTypeAsString

      public final String contentTypeAsString()

      The content type to use for token exchange 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, contentType will return ContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

      Returns:
      The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
      See Also:

    • 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 authorization code flow.

      Returns:
      The OAuth2 scope that defines the level of access requested for the authorization code flow.

    • prompt

      public final ConnectorProperty prompt()

      The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.

      Returns:
      The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.

    • 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 the isEmpty() 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 ConnectorAuthorizationCodeProperties.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ConnectorAuthorizationCodeProperties.Builder,ConnectorAuthorizationCodeProperties>
      Returns:
      a builder for type T

    • builder

      public static ConnectorAuthorizationCodeProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ConnectorAuthorizationCodeProperties.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.