Class Member

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

The representation of a user or group.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the member.

      Returns:
      The identifier of the member.

    • name

      public final String name()

      The name of the member.

      Returns:
      The name of the member.

    • type

      public final MemberType type()

      A member can be a user or group.

      If the service returns an enum value that is not available in the current SDK version, type will return MemberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      A member can be a user or group.
      See Also:

    • typeAsString

      public final String typeAsString()

      A member can be a user or group.

      If the service returns an enum value that is not available in the current SDK version, type will return MemberType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      A member can be a user or group.
      See Also:

    • state

      public final EntityState state()

      The state of the member, which can be ENABLED, DISABLED, or DELETED.

      If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the member, which can be ENABLED, DISABLED, or DELETED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the member, which can be ENABLED, DISABLED, or DELETED.

      If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the member, which can be ENABLED, DISABLED, or DELETED.
      See Also:

    • enabledDate

      public final Instant enabledDate()

      The date indicating when the member was enabled for WorkMail use.

      Returns:
      The date indicating when the member was enabled for WorkMail use.

    • disabledDate

      public final Instant disabledDate()

      The date indicating when the member was disabled from WorkMail use.

      Returns:
      The date indicating when the member was disabled from WorkMail use.

    • toBuilder

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

    • builder

      public static Member.Builder builder()

    • serializableBuilderClass

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