Class AuthorizationConfig

java.lang.Object
software.amazon.awssdk.services.apiportal.model.AuthorizationConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AuthorizationConfig.Builder,AuthorizationConfig>

@Generated("software.amazon.awssdk:codegen") public final class AuthorizationConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AuthorizationConfig.Builder,AuthorizationConfig>

Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

See Also:
  • Method Details

    • none

      public final None none()

      The portal is public and readers do not sign in.

      Returns:
      The portal is public and readers do not sign in.
    • cognitoConfig

      public final CognitoConfig cognitoConfig()

      Readers sign in through an Amazon Cognito user pool.

      Returns:
      Readers sign in through an Amazon Cognito user pool.
    • toBuilder

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

      public static AuthorizationConfig.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AuthorizationConfig.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)
    • fromNone

      public static AuthorizationConfig fromNone(None none)
      Create an instance of this class with none() initialized to the given value.

      The portal is public and readers do not sign in.

      Parameters:
      none - The portal is public and readers do not sign in.
    • fromNone

      public static AuthorizationConfig fromNone(Consumer<None.Builder> none)
      Create an instance of this class with none() initialized to the given value.

      The portal is public and readers do not sign in.

      Parameters:
      none - The portal is public and readers do not sign in.
    • fromCognitoConfig

      public static AuthorizationConfig fromCognitoConfig(CognitoConfig cognitoConfig)
      Create an instance of this class with cognitoConfig() initialized to the given value.

      Readers sign in through an Amazon Cognito user pool.

      Parameters:
      cognitoConfig - Readers sign in through an Amazon Cognito user pool.
    • fromCognitoConfig

      public static AuthorizationConfig fromCognitoConfig(Consumer<CognitoConfig.Builder> cognitoConfig)
      Create an instance of this class with cognitoConfig() initialized to the given value.

      Readers sign in through an Amazon Cognito user pool.

      Parameters:
      cognitoConfig - Readers sign in through an Amazon Cognito user pool.
    • type

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