Class Photo

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

Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.

See Also:

  • Method Details

    • value

      public final String value()

      The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.

      Returns:
      The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.

    • type

      public final String type()

      The type of photo. This field is optional and can be used to categorize different types of photos.

      Returns:
      The type of photo. This field is optional and can be used to categorize different types of photos.

    • display

      public final String display()

      A human-readable description of the photo for display purposes. This optional field provides context about the photo.

      Returns:
      A human-readable description of the photo for display purposes. This optional field provides context about the photo.

    • primary

      public final Boolean primary()

      Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.

      Returns:
      Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.

    • toBuilder

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

    • builder

      public static Photo.Builder builder()

    • serializableBuilderClass

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

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