Package software.amazon.awssdk.services.chimesdkmessaging.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChannelSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ChannelSummary.Builder	builder()
String	channelArn()	The ARN of 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 the last persistent message visible to the caller in a channel was sent.
String	metadata()	The metadata of the channel.
ChannelMode	mode()	The mode of the channel.
String	modeAsString()	The mode of the channel.
String	name()	The name of the channel.
ChannelPrivacy	privacy()	The privacy setting of the channel.
String	privacyAsString()	The privacy setting of the channel.
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelSummary.Builder>	serializableBuilderClass()
ChannelSummary.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 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:

ChannelPrivacy

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:

ChannelPrivacy

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelSummary.Builder,ChannelSummary>

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)

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