Interface Channel.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Channel.Builder,Channel>,SdkBuilder<Channel.Builder,Channel>,SdkPojo
- Enclosing class:
- Channel
public static interface Channel.Builder extends SdkPojo, CopyableBuilder<Channel.Builder,Channel>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Channel.BuilderchannelArn(String channelArn)The ARN of a channel.Channel.BuilderchannelFlowArn(String channelFlowArn)The ARN of the channel flow.default Channel.BuildercreatedBy(Consumer<Identity.Builder> createdBy)TheAppInstanceUserwho created the channel.Channel.BuildercreatedBy(Identity createdBy)TheAppInstanceUserwho created the channel.Channel.BuildercreatedTimestamp(Instant createdTimestamp)The time at which theAppInstanceUsercreated the channel.default Channel.BuilderelasticChannelConfiguration(Consumer<ElasticChannelConfiguration.Builder> elasticChannelConfiguration)The attributes required to configure and create an elastic channel.Channel.BuilderelasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)The attributes required to configure and create an elastic channel.default Channel.BuilderexpirationSettings(Consumer<ExpirationSettings.Builder> expirationSettings)Settings that control when a channel expires.Channel.BuilderexpirationSettings(ExpirationSettings expirationSettings)Settings that control when a channel expires.Channel.BuilderlastMessageTimestamp(Instant lastMessageTimestamp)The time at which a member sent the last message in the channel.Channel.BuilderlastUpdatedTimestamp(Instant lastUpdatedTimestamp)The time at which a channel was last updated.Channel.Buildermetadata(String metadata)The channel's metadata.Channel.Buildermode(String mode)The mode of the channel.Channel.Buildermode(ChannelMode mode)The mode of the channel.Channel.Buildername(String name)The name of a channel.Channel.Builderprivacy(String privacy)The channel's privacy setting.Channel.Builderprivacy(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 Detail
-
name
Channel.Builder name(String 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
Channel.Builder channelArn(String 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
Channel.Builder mode(String 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:
ChannelMode,ChannelMode
-
mode
Channel.Builder mode(ChannelMode 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:
ChannelMode,ChannelMode
-
privacy
Channel.Builder privacy(String 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:
ChannelPrivacy,ChannelPrivacy
-
privacy
Channel.Builder privacy(ChannelPrivacy 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:
ChannelPrivacy,ChannelPrivacy
-
metadata
Channel.Builder metadata(String 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
Channel.Builder createdBy(Identity createdBy)
The
AppInstanceUserwho created the channel.- Parameters:
createdBy- TheAppInstanceUserwho created the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
default Channel.Builder createdBy(Consumer<Identity.Builder> createdBy)
The
This is a convenience method that creates an instance of theAppInstanceUserwho created the channel.Identity.Builderavoiding the need to create one manually viaIdentity.builder().When the
Consumercompletes,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:
createdBy(Identity)
-
createdTimestamp
Channel.Builder createdTimestamp(Instant createdTimestamp)
The time at which the
AppInstanceUsercreated the channel.- Parameters:
createdTimestamp- The time at which theAppInstanceUsercreated the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastMessageTimestamp
Channel.Builder lastMessageTimestamp(Instant 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
Channel.Builder lastUpdatedTimestamp(Instant 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
Channel.Builder channelFlowArn(String 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.Builderavoiding the need to create one manually viaElasticChannelConfiguration.builder().When the
Consumercompletes,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:
elasticChannelConfiguration(ElasticChannelConfiguration)
-
expirationSettings
Channel.Builder expirationSettings(ExpirationSettings 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
default Channel.Builder expirationSettings(Consumer<ExpirationSettings.Builder> expirationSettings)
Settings that control when a channel expires.
This is a convenience method that creates an instance of theExpirationSettings.Builderavoiding the need to create one manually viaExpirationSettings.builder().When the
Consumercompletes,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:
expirationSettings(ExpirationSettings)
-
-