Channel (AWS Java SDK :: Services :: Chime SDK Messaging 2.21.4 API)

java.lang.Object
- software.amazon.awssdk.services.chimesdkmessaging.model.Channel

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Channel.Builder,Channel>

@Generated(value="software.amazon.awssdk:codegen")
public final class Channel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Channel.Builder,Channel>

The details of a channel.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Channel.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Channel.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Channel.Builder`	`builder()`
`String`	`channelArn()` The ARN of a channel.
`String`	`channelFlowArn()` The ARN of the channel flow.
`Identity`	`createdBy()` The `AppInstanceUser` who created the channel.
`Instant`	`createdTimestamp()` The time at which the `AppInstanceUser` created the channel.
`ElasticChannelConfiguration`	`elasticChannelConfiguration()` The attributes required to configure and create an elastic channel.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExpirationSettings`	`expirationSettings()` Settings that control when a channel expires.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastMessageTimestamp()` The time at which a member sent the last message in the channel.
`Instant`	`lastUpdatedTimestamp()` The time at which a channel was last updated.
`String`	`metadata()` The channel's metadata.
`ChannelMode`	`mode()` The mode of the channel.
`String`	`modeAsString()` The mode of the channel.
`String`	`name()` The name of a channel.
`ChannelPrivacy`	`privacy()` The channel's privacy setting.
`String`	`privacyAsString()` The channel's privacy setting.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Channel.Builder>`	`serializableBuilderClass()`
`Channel.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ChannelMode
  - 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:
    
    ChannelMode
  - 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:
    
    ChannelPrivacy
  - 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:
    
    ChannelPrivacy
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Channel

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

channelArn

mode

modeAsString

privacy

privacyAsString

metadata

createdBy

createdTimestamp

lastMessageTimestamp

lastUpdatedTimestamp

channelFlowArn

elasticChannelConfiguration

expirationSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields