Package software.amazon.awssdk.services.chime.model

Class Channel

java.lang.Object

software.amazon.awssdk.services.chime.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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Channel.Builder

Method Summary

Modifier and Type	Method	Description
static Channel.Builder	builder()
String	channelArn()	The ARN of the channel.
Identity	createdBy()	The AppInstanceUser who created the channel.
Instant	createdTimestamp()	The time at which the AppInstanceUser created the channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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 the channel.
ChannelPrivacy	privacy()	The channel's privacy setting.
String	privacyAsString()	The channel's privacy setting.
Map<String,SdkField<?>>	sdkFieldNameToField()
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 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:

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.

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo