Class ReadAuthenticationMetadata

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

Read-only authentication metadata union containing non-sensitive configuration details for different authentication types.

See Also:

  • Method Details

    • authorizationCodeGrantMetadata

      public final ReadAuthorizationCodeGrantMetadata authorizationCodeGrantMetadata()

      Read-only metadata for OAuth2 authorization code grant flow configuration.

      Returns:
      Read-only metadata for OAuth2 authorization code grant flow configuration.

    • clientCredentialsGrantMetadata

      public final ReadClientCredentialsGrantMetadata clientCredentialsGrantMetadata()

      Read-only metadata for OAuth2 client credentials grant flow configuration.

      Returns:
      Read-only metadata for OAuth2 client credentials grant flow configuration.

    • basicAuthConnectionMetadata

      public final ReadBasicAuthConnectionMetadata basicAuthConnectionMetadata()

      Read-only metadata for basic authentication configuration.

      Returns:
      Read-only metadata for basic authentication configuration.

    • apiKeyConnectionMetadata

      public final ReadAPIKeyConnectionMetadata apiKeyConnectionMetadata()

      Read-only metadata for API key authentication configuration.

      Returns:
      Read-only metadata for API key authentication configuration.

    • noneConnectionMetadata

      public final ReadNoneConnectionMetadata noneConnectionMetadata()

      Read-only metadata for connections that do not require authentication.

      Returns:
      Read-only metadata for connections that do not require authentication.

    • iamConnectionMetadata

      public final ReadIamConnectionMetadata iamConnectionMetadata()

      Read-only metadata for IAM-based authentication configuration.

      Returns:
      Read-only metadata for IAM-based authentication configuration.

    • toBuilder

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

    • builder

      public static ReadAuthenticationMetadata.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReadAuthenticationMetadata.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 ReadAuthenticationMetadata fromAuthorizationCodeGrantMetadata(ReadAuthorizationCodeGrantMetadata authorizationCodeGrantMetadata)
      Create an instance of this class with authorizationCodeGrantMetadata() initialized to the given value.

      Read-only metadata for OAuth2 authorization code grant flow configuration.

      Parameters:
      authorizationCodeGrantMetadata - Read-only metadata for OAuth2 authorization code grant flow configuration.

    • fromAuthorizationCodeGrantMetadata

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

      Read-only metadata for OAuth2 authorization code grant flow configuration.

      Parameters:
      authorizationCodeGrantMetadata - Read-only metadata for OAuth2 authorization code grant flow configuration.

    • fromClientCredentialsGrantMetadata

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

      Read-only metadata for OAuth2 client credentials grant flow configuration.

      Parameters:
      clientCredentialsGrantMetadata - Read-only metadata for OAuth2 client credentials grant flow configuration.

    • fromClientCredentialsGrantMetadata

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

      Read-only metadata for OAuth2 client credentials grant flow configuration.

      Parameters:
      clientCredentialsGrantMetadata - Read-only metadata for OAuth2 client credentials grant flow configuration.

    • fromBasicAuthConnectionMetadata

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

      Read-only metadata for basic authentication configuration.

      Parameters:
      basicAuthConnectionMetadata - Read-only metadata for basic authentication configuration.

    • fromBasicAuthConnectionMetadata

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

      Read-only metadata for basic authentication configuration.

      Parameters:
      basicAuthConnectionMetadata - Read-only metadata for basic authentication configuration.

    • fromApiKeyConnectionMetadata

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

      Read-only metadata for API key authentication configuration.

      Parameters:
      apiKeyConnectionMetadata - Read-only metadata for API key authentication configuration.

    • fromApiKeyConnectionMetadata

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

      Read-only metadata for API key authentication configuration.

      Parameters:
      apiKeyConnectionMetadata - Read-only metadata for API key authentication configuration.

    • fromNoneConnectionMetadata

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

      Read-only metadata for connections that do not require authentication.

      Parameters:
      noneConnectionMetadata - Read-only metadata for connections that do not require authentication.

    • fromNoneConnectionMetadata

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

      Read-only metadata for connections that do not require authentication.

      Parameters:
      noneConnectionMetadata - Read-only metadata for connections that do not require authentication.

    • fromIamConnectionMetadata

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

      Read-only metadata for IAM-based authentication configuration.

      Parameters:
      iamConnectionMetadata - Read-only metadata for IAM-based authentication configuration.

    • fromIamConnectionMetadata

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

      Read-only metadata for IAM-based authentication configuration.

      Parameters:
      iamConnectionMetadata - Read-only metadata for IAM-based authentication configuration.

    • type

      public ReadAuthenticationMetadata.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 ReadAuthenticationMetadata.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 ReadAuthenticationMetadata.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.