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 Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 AppInstanceUser who created the channel.

      Parameters:
      createdBy - The AppInstanceUser who 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 AppInstanceUser who created the channel.

      This is a convenience method that creates an instance of the Identity.Builder avoiding the need to create one manually via Identity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createdBy(Identity).

      Parameters:
      createdBy - a consumer that will call methods on Identity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTimestamp

      Channel.Builder createdTimestamp(Instant createdTimestamp)

      The time at which the AppInstanceUser created the channel.

      Parameters:
      createdTimestamp - The time at which the AppInstanceUser created 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 the ElasticChannelConfiguration.Builder avoiding the need to create one manually via ElasticChannelConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticChannelConfiguration(ElasticChannelConfiguration).

      Parameters:
      elasticChannelConfiguration - a consumer that will call methods on ElasticChannelConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the ExpirationSettings.Builder avoiding the need to create one manually via ExpirationSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to expirationSettings(ExpirationSettings).

      Parameters:
      expirationSettings - a consumer that will call methods on ExpirationSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: