Interface Channel.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Channel.Builder,
,Channel> SdkBuilder<Channel.Builder,
,Channel> SdkPojo
- Enclosing class:
Channel
-
Method Summary
Modifier and TypeMethodDescriptionchannelArn
(String channelArn) The ARN of a channel.channelFlowArn
(String channelFlowArn) The ARN of the channel flow.default Channel.Builder
createdBy
(Consumer<Identity.Builder> createdBy) TheAppInstanceUser
who created the channel.TheAppInstanceUser
who created the channel.createdTimestamp
(Instant createdTimestamp) The time at which theAppInstanceUser
created the channel.default Channel.Builder
elasticChannelConfiguration
(Consumer<ElasticChannelConfiguration.Builder> elasticChannelConfiguration) The attributes required to configure and create an elastic channel.elasticChannelConfiguration
(ElasticChannelConfiguration elasticChannelConfiguration) The attributes required to configure and create an elastic channel.default Channel.Builder
expirationSettings
(Consumer<ExpirationSettings.Builder> expirationSettings) Settings that control when a channel expires.expirationSettings
(ExpirationSettings expirationSettings) Settings that control when a channel expires.lastMessageTimestamp
(Instant lastMessageTimestamp) The time at which a member sent the last message in the channel.lastUpdatedTimestamp
(Instant lastUpdatedTimestamp) The time at which a channel was last updated.The channel's metadata.The mode of the channel.mode
(ChannelMode mode) The mode of the channel.The name of a channel.The channel's privacy setting.privacy
(ChannelPrivacy privacy) The channel's privacy setting.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of a channel.
- Parameters:
name
- The name of a channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelArn
The ARN of a channel.
- Parameters:
channelArn
- The ARN of a channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mode
The mode of the channel.
- Parameters:
mode
- The mode of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mode
The mode of the channel.
- Parameters:
mode
- The mode of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
privacy
The channel's privacy setting.
- Parameters:
privacy
- The channel's privacy setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
privacy
The channel's privacy setting.
- Parameters:
privacy
- The channel's privacy setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metadata
The channel's metadata.
- Parameters:
metadata
- The channel's metadata.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
The
AppInstanceUser
who created the channel.- Parameters:
createdBy
- TheAppInstanceUser
who created the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
The
This is a convenience method that creates an instance of theAppInstanceUser
who created the channel.Identity.Builder
avoiding the need to create one manually viaIdentity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreatedBy(Identity)
.- Parameters:
createdBy
- a consumer that will call methods onIdentity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdTimestamp
The time at which the
AppInstanceUser
created the channel.- Parameters:
createdTimestamp
- The time at which theAppInstanceUser
created the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastMessageTimestamp
The time at which a member sent the last message in the channel.
- Parameters:
lastMessageTimestamp
- The time at which a member sent the last message in the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedTimestamp
The time at which a channel was last updated.
- Parameters:
lastUpdatedTimestamp
- The time at which a channel was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelFlowArn
The ARN of the channel flow.
- Parameters:
channelFlowArn
- The ARN of the channel flow.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
elasticChannelConfiguration
Channel.Builder elasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration) The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
- Parameters:
elasticChannelConfiguration
- The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
elasticChannelConfiguration
default Channel.Builder elasticChannelConfiguration(Consumer<ElasticChannelConfiguration.Builder> elasticChannelConfiguration) The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.
This is a convenience method that creates an instance of theElasticChannelConfiguration.Builder
avoiding the need to create one manually viaElasticChannelConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toelasticChannelConfiguration(ElasticChannelConfiguration)
.- Parameters:
elasticChannelConfiguration
- a consumer that will call methods onElasticChannelConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
expirationSettings
Settings that control when a channel expires.
- Parameters:
expirationSettings
- Settings that control when a channel expires.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expirationSettings
Settings that control when a channel expires.
This is a convenience method that creates an instance of theExpirationSettings.Builder
avoiding the need to create one manually viaExpirationSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexpirationSettings(ExpirationSettings)
.- Parameters:
expirationSettings
- a consumer that will call methods onExpirationSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-