Class UserIdentifier

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

A structure that contains information to identify a user.

See Also:

  • Method Details

    • userName

      public final String userName()

      The name of the user that you want to get identity context for.

      Returns:
      The name of the user that you want to get identity context for.

    • email

      public final String email()

      The email address of the user that you want to get identity context for.

      Returns:
      The email address of the user that you want to get identity context for.

    • userArn

      public final String userArn()

      The Amazon Resource Name (ARN) of the user that you want to get identity context for.

      Returns:
      The Amazon Resource Name (ARN) of the user that you want to get identity context for.

    • toBuilder

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

    • builder

      public static UserIdentifier.Builder builder()

    • serializableBuilderClass

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

    • fromUserName

      public static UserIdentifier fromUserName(String userName)
      Create an instance of this class with userName() initialized to the given value.

      The name of the user that you want to get identity context for.

      Parameters:
      userName - The name of the user that you want to get identity context for.

    • fromEmail

      public static UserIdentifier fromEmail(String email)
      Create an instance of this class with email() initialized to the given value.

      The email address of the user that you want to get identity context for.

      Parameters:
      email - The email address of the user that you want to get identity context for.

    • fromUserArn

      public static UserIdentifier fromUserArn(String userArn)
      Create an instance of this class with userArn() initialized to the given value.

      The Amazon Resource Name (ARN) of the user that you want to get identity context for.

      Parameters:
      userArn - The Amazon Resource Name (ARN) of the user that you want to get identity context for.

    • type

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