Class ChannelSummary

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

Summary of the details of a Channel.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the channel.

      Returns:
      The name of the channel.

    • channelArn

      public final String channelArn()

      The ARN of the channel.

      Returns:
      The ARN of the channel.

    • mode

      public final ChannelMode mode()

      The mode of the channel.

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

      Returns:
      The mode of the channel.
      See Also:

    • modeAsString

      public final String modeAsString()

      The mode of the channel.

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

      Returns:
      The mode of the channel.
      See Also:

    • privacy

      public final ChannelPrivacy privacy()

      The privacy setting of the channel.

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

      Returns:
      The privacy setting of the channel.
      See Also:

    • privacyAsString

      public final String privacyAsString()

      The privacy setting of the channel.

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

      Returns:
      The privacy setting of the channel.
      See Also:

    • metadata

      public final String metadata()

      The metadata of the channel.

      Returns:
      The metadata of the channel.

    • lastMessageTimestamp

      public final Instant lastMessageTimestamp()

      The time at which the last persistent message visible to the caller in a channel was sent.

      Returns:
      The time at which the last persistent message visible to the caller in a channel was sent.

    • toBuilder

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

    • builder

      public static ChannelSummary.Builder builder()

    • serializableBuilderClass

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