Class OAuthParameters

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

An object that contains information needed to create a data source connection that uses OAuth client credentials. This option is available for data source connections that are made with Snowflake and Starburst.

See Also:

  • Method Details

    • tokenProviderUrl

      public final String tokenProviderUrl()

      The token endpoint URL of the identity provider.

      Returns:
      The token endpoint URL of the identity provider.

    • oAuthScope

      public final String oAuthScope()

      The OAuth scope.

      Returns:
      The OAuth scope.

    • identityProviderVpcConnectionProperties

      public final VpcConnectionProperties identityProviderVpcConnectionProperties()
      Returns the value of the IdentityProviderVpcConnectionProperties property for this object.
      Returns:
      The value of the IdentityProviderVpcConnectionProperties property for this object.

    • identityProviderResourceUri

      public final String identityProviderResourceUri()

      The resource uri of the identity provider.

      Returns:
      The resource uri of the identity provider.

    • identityProviderCACertificatesBundleS3Uri

      public final String identityProviderCACertificatesBundleS3Uri()

      The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.

      Returns:
      The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.

    • toBuilder

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

    • builder

      public static OAuthParameters.Builder builder()

    • serializableBuilderClass

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