Class AlternateIdentifier

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

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute.

See Also:

  • Method Details

    • externalId

      public final ExternalId externalId()

      The identifier issued to this resource by an external identity provider.

      Returns:
      The identifier issued to this resource by an external identity provider.

    • uniqueAttribute

      public final UniqueAttribute uniqueAttribute()

      An entity attribute that's unique to a specific entity.

      Returns:
      An entity attribute that's unique to a specific entity.

    • toBuilder

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

    • builder

      public static AlternateIdentifier.Builder builder()

    • serializableBuilderClass

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

    • fromExternalId

      public static AlternateIdentifier fromExternalId(ExternalId externalId)
      Create an instance of this class with externalId() initialized to the given value.

      The identifier issued to this resource by an external identity provider.

      Parameters:
      externalId - The identifier issued to this resource by an external identity provider.

    • fromExternalId

      public static AlternateIdentifier fromExternalId(Consumer<ExternalId.Builder> externalId)
      Create an instance of this class with externalId() initialized to the given value.

      The identifier issued to this resource by an external identity provider.

      Parameters:
      externalId - The identifier issued to this resource by an external identity provider.

    • fromUniqueAttribute

      public static AlternateIdentifier fromUniqueAttribute(UniqueAttribute uniqueAttribute)
      Create an instance of this class with uniqueAttribute() initialized to the given value.

      An entity attribute that's unique to a specific entity.

      Parameters:
      uniqueAttribute - An entity attribute that's unique to a specific entity.

    • fromUniqueAttribute

      public static AlternateIdentifier fromUniqueAttribute(Consumer<UniqueAttribute.Builder> uniqueAttribute)
      Create an instance of this class with uniqueAttribute() initialized to the given value.

      An entity attribute that's unique to a specific entity.

      Parameters:
      uniqueAttribute - An entity attribute that's unique to a specific entity.

    • type

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