Class Channel
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Channel.Builder,
Channel>
The details of a channel.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Channel.Builder
builder()
final String
The ARN of a channel.final String
The ARN of the channel flow.final Identity
TheAppInstanceUser
who created the channel.final Instant
The time at which theAppInstanceUser
created the channel.The attributes required to configure and create an elastic channel.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExpirationSettings
Settings that control when a channel expires.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The time at which a member sent the last message in the channel.final Instant
The time at which a channel was last updated.final String
metadata()
The channel's metadata.final ChannelMode
mode()
The mode of the channel.final String
The mode of the channel.final String
name()
The name of a channel.final ChannelPrivacy
privacy()
The channel's privacy setting.final String
The channel's privacy setting.static Class
<? extends Channel.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of a channel.
- Returns:
- The name of a channel.
-
channelArn
The ARN of a channel.
- Returns:
- The ARN of a channel.
-
mode
The mode of the channel.
If the service returns an enum value that is not available in the current SDK version,
mode
will returnChannelMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The mode of the channel.
- See Also:
-
modeAsString
The mode of the channel.
If the service returns an enum value that is not available in the current SDK version,
mode
will returnChannelMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- The mode of the channel.
- See Also:
-
privacy
The channel's privacy setting.
If the service returns an enum value that is not available in the current SDK version,
privacy
will returnChannelPrivacy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprivacyAsString()
.- Returns:
- The channel's privacy setting.
- See Also:
-
privacyAsString
The channel's privacy setting.
If the service returns an enum value that is not available in the current SDK version,
privacy
will returnChannelPrivacy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprivacyAsString()
.- Returns:
- The channel's privacy setting.
- See Also:
-
metadata
The channel's metadata.
- Returns:
- The channel's metadata.
-
createdBy
The
AppInstanceUser
who created the channel.- Returns:
- The
AppInstanceUser
who created the channel.
-
createdTimestamp
The time at which the
AppInstanceUser
created the channel.- Returns:
- The time at which the
AppInstanceUser
created the channel.
-
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
The time at which a channel was last updated.
- Returns:
- The time at which a channel was last updated.
-
channelFlowArn
The ARN of the channel flow.
- Returns:
- The ARN of the channel flow.
-
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
Settings that control when a channel expires.
- Returns:
- Settings that control when a channel expires.
-
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 interfaceToCopyableBuilder<Channel.Builder,
Channel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-