Class OAuthConfig

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

Configuration details for OAuth authentication with a third-party service.

See Also:

  • Method Details

    • authUrl

      public final String authUrl()

      The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

      Returns:
      The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.

    • tokenUrl

      public final String tokenUrl()

      The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

      Returns:
      The token URL for the OAuth service, where authorization codes are exchanged for access tokens.

    • scope

      public final String scope()

      The OAuth scopes requested during authorization, which define the permissions granted to the application.

      Returns:
      The OAuth scopes requested during authorization, which define the permissions granted to the application.

    • tokenEndpointAuthenticationScheme

      public final TokenEndpointAuthenticationScheme tokenEndpointAuthenticationScheme()

      The authentication scheme used when requesting tokens from the token endpoint.

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

      Returns:
      The authentication scheme used when requesting tokens from the token endpoint.
      See Also:

    • tokenEndpointAuthenticationSchemeAsString

      public final String tokenEndpointAuthenticationSchemeAsString()

      The authentication scheme used when requesting tokens from the token endpoint.

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

      Returns:
      The authentication scheme used when requesting tokens from the token endpoint.
      See Also:

    • oAuthCompleteRedirectUrl

      public final String oAuthCompleteRedirectUrl()

      The URL where users are redirected after completing the OAuth authorization process.

      Returns:
      The URL where users are redirected after completing the OAuth authorization process.

    • proactiveRefreshTokenRenewal

      public final ProactiveRefreshTokenRenewal proactiveRefreshTokenRenewal()

      Configuration for proactively refreshing OAuth tokens before they expire.

      Returns:
      Configuration for proactively refreshing OAuth tokens before they expire.

    • toBuilder

      public OAuthConfig.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<OAuthConfig.Builder,OAuthConfig>
      Returns:
      a builder for type T

    • builder

      public static OAuthConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OAuthConfig.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.