Class AuthenticationMetadata

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

Union type containing authentication metadata for different authentication methods.

See Also:

  • Method Details

    • authorizationCodeGrantMetadata

      public final AuthorizationCodeGrantMetadata authorizationCodeGrantMetadata()

      OAuth 2.0 authorization code grant authentication metadata.

      Returns:
      OAuth 2.0 authorization code grant authentication metadata.

    • clientCredentialsGrantMetadata

      public final ClientCredentialsGrantMetadata clientCredentialsGrantMetadata()

      OAuth 2.0 client credentials grant authentication metadata.

      Returns:
      OAuth 2.0 client credentials grant authentication metadata.

    • basicAuthConnectionMetadata

      public final BasicAuthConnectionMetadata basicAuthConnectionMetadata()

      Basic authentication metadata using username and password.

      Returns:
      Basic authentication metadata using username and password.

    • apiKeyConnectionMetadata

      public final APIKeyConnectionMetadata apiKeyConnectionMetadata()

      API key authentication metadata.

      Returns:
      API key authentication metadata.

    • noneConnectionMetadata

      public final NoneConnectionMetadata noneConnectionMetadata()

      No authentication metadata for services that don't require authentication.

      Returns:
      No authentication metadata for services that don't require authentication.

    • iamConnectionMetadata

      public final IAMConnectionMetadata iamConnectionMetadata()

      IAM role-based authentication metadata for Amazon Web Services services.

      Returns:
      IAM role-based authentication metadata for Amazon Web Services services.

    • toBuilder

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

    • builder

      public static AuthenticationMetadata.Builder builder()

    • serializableBuilderClass

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

    • fromAuthorizationCodeGrantMetadata

      public static AuthenticationMetadata fromAuthorizationCodeGrantMetadata(AuthorizationCodeGrantMetadata authorizationCodeGrantMetadata)
      Create an instance of this class with authorizationCodeGrantMetadata() initialized to the given value.

      OAuth 2.0 authorization code grant authentication metadata.

      Parameters:
      authorizationCodeGrantMetadata - OAuth 2.0 authorization code grant authentication metadata.

    • fromAuthorizationCodeGrantMetadata

      public static AuthenticationMetadata fromAuthorizationCodeGrantMetadata(Consumer<AuthorizationCodeGrantMetadata.Builder> authorizationCodeGrantMetadata)
      Create an instance of this class with authorizationCodeGrantMetadata() initialized to the given value.

      OAuth 2.0 authorization code grant authentication metadata.

      Parameters:
      authorizationCodeGrantMetadata - OAuth 2.0 authorization code grant authentication metadata.

    • fromClientCredentialsGrantMetadata

      public static AuthenticationMetadata fromClientCredentialsGrantMetadata(ClientCredentialsGrantMetadata clientCredentialsGrantMetadata)
      Create an instance of this class with clientCredentialsGrantMetadata() initialized to the given value.

      OAuth 2.0 client credentials grant authentication metadata.

      Parameters:
      clientCredentialsGrantMetadata - OAuth 2.0 client credentials grant authentication metadata.

    • fromClientCredentialsGrantMetadata

      public static AuthenticationMetadata fromClientCredentialsGrantMetadata(Consumer<ClientCredentialsGrantMetadata.Builder> clientCredentialsGrantMetadata)
      Create an instance of this class with clientCredentialsGrantMetadata() initialized to the given value.

      OAuth 2.0 client credentials grant authentication metadata.

      Parameters:
      clientCredentialsGrantMetadata - OAuth 2.0 client credentials grant authentication metadata.

    • fromBasicAuthConnectionMetadata

      public static AuthenticationMetadata fromBasicAuthConnectionMetadata(BasicAuthConnectionMetadata basicAuthConnectionMetadata)
      Create an instance of this class with basicAuthConnectionMetadata() initialized to the given value.

      Basic authentication metadata using username and password.

      Parameters:
      basicAuthConnectionMetadata - Basic authentication metadata using username and password.

    • fromBasicAuthConnectionMetadata

      public static AuthenticationMetadata fromBasicAuthConnectionMetadata(Consumer<BasicAuthConnectionMetadata.Builder> basicAuthConnectionMetadata)
      Create an instance of this class with basicAuthConnectionMetadata() initialized to the given value.

      Basic authentication metadata using username and password.

      Parameters:
      basicAuthConnectionMetadata - Basic authentication metadata using username and password.

    • fromApiKeyConnectionMetadata

      public static AuthenticationMetadata fromApiKeyConnectionMetadata(APIKeyConnectionMetadata apiKeyConnectionMetadata)
      Create an instance of this class with apiKeyConnectionMetadata() initialized to the given value.

      API key authentication metadata.

      Parameters:
      apiKeyConnectionMetadata - API key authentication metadata.

    • fromApiKeyConnectionMetadata

      public static AuthenticationMetadata fromApiKeyConnectionMetadata(Consumer<APIKeyConnectionMetadata.Builder> apiKeyConnectionMetadata)
      Create an instance of this class with apiKeyConnectionMetadata() initialized to the given value.

      API key authentication metadata.

      Parameters:
      apiKeyConnectionMetadata - API key authentication metadata.

    • fromNoneConnectionMetadata

      public static AuthenticationMetadata fromNoneConnectionMetadata(NoneConnectionMetadata noneConnectionMetadata)
      Create an instance of this class with noneConnectionMetadata() initialized to the given value.

      No authentication metadata for services that don't require authentication.

      Parameters:
      noneConnectionMetadata - No authentication metadata for services that don't require authentication.

    • fromNoneConnectionMetadata

      public static AuthenticationMetadata fromNoneConnectionMetadata(Consumer<NoneConnectionMetadata.Builder> noneConnectionMetadata)
      Create an instance of this class with noneConnectionMetadata() initialized to the given value.

      No authentication metadata for services that don't require authentication.

      Parameters:
      noneConnectionMetadata - No authentication metadata for services that don't require authentication.

    • fromIamConnectionMetadata

      public static AuthenticationMetadata fromIamConnectionMetadata(IAMConnectionMetadata iamConnectionMetadata)
      Create an instance of this class with iamConnectionMetadata() initialized to the given value.

      IAM role-based authentication metadata for Amazon Web Services services.

      Parameters:
      iamConnectionMetadata - IAM role-based authentication metadata for Amazon Web Services services.

    • fromIamConnectionMetadata

      public static AuthenticationMetadata fromIamConnectionMetadata(Consumer<IAMConnectionMetadata.Builder> iamConnectionMetadata)
      Create an instance of this class with iamConnectionMetadata() initialized to the given value.

      IAM role-based authentication metadata for Amazon Web Services services.

      Parameters:
      iamConnectionMetadata - IAM role-based authentication metadata for Amazon Web Services services.

    • type

      public AuthenticationMetadata.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be AuthenticationMetadata.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be AuthenticationMetadata.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.