Class ChannelMembership

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

The details of a channel member.

See Also:

  • Method Details

    • invitedBy

      public final Identity invitedBy()

      The identifier of the member who invited another member.

      Returns:
      The identifier of the member who invited another member.

    • type

      public final ChannelMembershipType type()

      The membership type set for the channel member.

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

      Returns:
      The membership type set for the channel member.
      See Also:

    • typeAsString

      public final String typeAsString()

      The membership type set for the channel member.

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

      Returns:
      The membership type set for the channel member.
      See Also:

    • member

      public final Identity member()

      The data of the channel member.

      Returns:
      The data of the channel member.

    • channelArn

      public final String channelArn()

      The ARN of the member's channel.

      Returns:
      The ARN of the member's channel.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which the channel membership was created.

      Returns:
      The time at which the channel membership was created.

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The time at which a channel membership was last updated.

      Returns:
      The time at which a channel membership was last updated.

    • subChannelId

      public final String subChannelId()

      The ID of the SubChannel that a user belongs to.

      Returns:
      The ID of the SubChannel that a user belongs to.

    • toBuilder

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

    • builder

      public static ChannelMembership.Builder builder()

    • serializableBuilderClass

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