Interface ChannelSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ChannelSummary.Builder,ChannelSummary>, SdkBuilder<ChannelSummary.Builder,ChannelSummary>, SdkPojo
Enclosing class:
ChannelSummary
@Mutable @NotThreadSafe public static interface ChannelSummary.Builder extends SdkPojo, CopyableBuilder<ChannelSummary.Builder,ChannelSummary>

  • Method Details

    • channelName

      ChannelSummary.Builder channelName(String channelName)

      The name of the channel.

      Parameters:
      channelName - The name of the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelARN

      ChannelSummary.Builder channelARN(String channelARN)

      The Amazon Resource Name (ARN) of the channel.

      Parameters:
      channelARN - The Amazon Resource Name (ARN) of the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelId

      ChannelSummary.Builder channelId(String channelId)

      The unique identifier of the channel.

      Parameters:
      channelId - The unique identifier of the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelStatus

      ChannelSummary.Builder channelStatus(String channelStatus)

      The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

      Parameters:
      channelStatus - The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channelStatus

      ChannelSummary.Builder channelStatus(ChannelStatus channelStatus)

      The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

      Parameters:
      channelStatus - The current status of the channel. Valid values:

      • CREATING - The channel is being created.

      • ACTIVE - The channel is ready to deliver records.

      • UPDATING - The channel configuration is being updated.

      • DELETING - The channel is being deleted.

      • FAILED - See ChannelStatusReason for the failure cause.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channelStatusReason

      ChannelSummary.Builder channelStatusReason(String channelStatusReason)

      A message describing the reason for a FAILED status.

      Parameters:
      channelStatusReason - A message describing the reason for a FAILED status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelCreationTimestamp

      ChannelSummary.Builder channelCreationTimestamp(Instant channelCreationTimestamp)

      The time at which the channel was created.

      Parameters:
      channelCreationTimestamp - The time at which the channel was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channelDestinationType

      ChannelSummary.Builder channelDestinationType(String channelDestinationType)

      The destination type of the channel. Valid values:

      • S3 - Delivery to a general purpose Amazon S3 bucket.

      • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

      Parameters:
      channelDestinationType - The destination type of the channel. Valid values:

      • S3 - Delivery to a general purpose Amazon S3 bucket.

      • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • channelDestinationType

      ChannelSummary.Builder channelDestinationType(ChannelDestinationType channelDestinationType)

      The destination type of the channel. Valid values:

      • S3 - Delivery to a general purpose Amazon S3 bucket.

      • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

      Parameters:
      channelDestinationType - The destination type of the channel. Valid values:

      • S3 - Delivery to a general purpose Amazon S3 bucket.

      • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streams

      ChannelSummary.Builder streams(Collection<ChannelStreamIdentifier> streams)

      The source streams associated with the channel.

      Parameters:
      streams - The source streams associated with the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streams

      ChannelSummary.Builder streams(ChannelStreamIdentifier... streams)

      The source streams associated with the channel.

      Parameters:
      streams - The source streams associated with the channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streams

      ChannelSummary.Builder streams(Consumer<ChannelStreamIdentifier.Builder>... streams)

      The source streams associated with the channel.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streams(List<ChannelStreamIdentifier>).

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