Class Channel

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

The details of a channel.

See Also:

  • Method Details

    • name

      public final String name()

      The name of a channel.

      Returns:
      The name of a channel.

    • channelArn

      public final String channelArn()

      The ARN of a channel.

      Returns:
      The ARN of a 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 channel's privacy setting.

      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 channel's privacy setting.
      See Also:

    • privacyAsString

      public final String privacyAsString()

      The channel's privacy setting.

      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 channel's privacy setting.
      See Also:

    • metadata

      public final String metadata()

      The channel's metadata.

      Returns:
      The channel's metadata.

    • createdBy

      public final Identity createdBy()

      The AppInstanceUser who created the channel.

      Returns:
      The AppInstanceUser who created the channel.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time at which the AppInstanceUser created the channel.

      Returns:
      The time at which the AppInstanceUser created the channel.

    • lastMessageTimestamp

      public final Instant lastMessageTimestamp()

      The time at which a member sent the last message in the channel.

      Returns:
      The time at which a member sent the last message in the channel.

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The time at which a channel was last updated.

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

    • channelFlowArn

      public final String channelFlowArn()

      The ARN of the channel flow.

      Returns:
      The ARN of the channel flow.

    • elasticChannelConfiguration

      public final ElasticChannelConfiguration elasticChannelConfiguration()

      The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

      Returns:
      The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

    • expirationSettings

      public final ExpirationSettings expirationSettings()

      Settings that control when a channel expires.

      Returns:
      Settings that control when a channel expires.

    • toBuilder

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

    • builder

      public static Channel.Builder builder()

    • serializableBuilderClass

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