Class OAuth2ClientCredentialConfiguration

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

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

See Also:

  • Method Details

    • secretArn

      public final String secretArn()

      The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

      Returns:
      The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

    • roleArn

      public final String roleArn()

      The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

      Returns:
      The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

    • authorizationUrl

      public final String authorizationUrl()

      The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

      Returns:
      The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

    • tokenUrl

      public final String tokenUrl()

      The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

      Returns:
      The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

    • toBuilder

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

    • builder

      public static OAuth2ClientCredentialConfiguration.Builder builder()

    • serializableBuilderClass

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