Interface DescribeChannelResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeChannelResponse.Builder,DescribeChannelResponse>, KafkaResponse.Builder, SdkBuilder<DescribeChannelResponse.Builder,DescribeChannelResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeChannelResponse

@Mutable
@NotThreadSafe
public static interface DescribeChannelResponse.Builder
extends KafkaResponse.Builder, SdkPojo, CopyableBuilder<DescribeChannelResponse.Builder,DescribeChannelResponse>

Method Summary

Modifier and Type	Method	Description
DescribeChannelResponse.Builder	channelArn(String channelArn)	The Amazon Resource Name (ARN) that uniquely identifies the channel.
DescribeChannelResponse.Builder	channelName(String channelName)	The name of the channel.
DescribeChannelResponse.Builder	clusterOperationArn(String clusterOperationArn)	The Amazon Resource Name (ARN) of the in-flight cluster operation.
DescribeChannelResponse.Builder	creationTime(Instant creationTime)	The time when the channel was created.
DescribeChannelResponse.Builder	destinationType(String destinationType)	The type of destination configured for the channel.
DescribeChannelResponse.Builder	destinationType(ChannelDestinationType destinationType)	The type of destination configured for the channel.
default DescribeChannelResponse.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	The encryption configuration applied to the channel.
DescribeChannelResponse.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	The encryption configuration applied to the channel.
default DescribeChannelResponse.Builder	icebergDestinationConfiguration(Consumer<IcebergDestinationConfiguration.Builder> icebergDestinationConfiguration)	The Apache Iceberg destination for the channel, if configured.
DescribeChannelResponse.Builder	icebergDestinationConfiguration(IcebergDestinationConfiguration icebergDestinationConfiguration)	The Apache Iceberg destination for the channel, if configured.
default DescribeChannelResponse.Builder	loggingInfo(Consumer<ChannelLoggingInfo.Builder> loggingInfo)	The destinations to which the channel publishes operational logs.
DescribeChannelResponse.Builder	loggingInfo(ChannelLoggingInfo loggingInfo)	The destinations to which the channel publishes operational logs.
default DescribeChannelResponse.Builder	s3DestinationConfiguration(Consumer<S3DestinationConfiguration.Builder> s3DestinationConfiguration)	The Amazon S3 destination for the channel, if configured.
DescribeChannelResponse.Builder	s3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration)	The Amazon S3 destination for the channel, if configured.
default DescribeChannelResponse.Builder	stateInfo(Consumer<ChannelStateInfo.Builder> stateInfo)	Additional context for the current channel state, populated when the channel is in FAILED.
DescribeChannelResponse.Builder	stateInfo(ChannelStateInfo stateInfo)	Additional context for the current channel state, populated when the channel is in FAILED.
DescribeChannelResponse.Builder	status(String status)	The current lifecycle state of the channel.
DescribeChannelResponse.Builder	status(ChannelStatus status)	The current lifecycle state of the channel.
DescribeChannelResponse.Builder	tags(Map<String,String> tags)	The tags attached to the channel.
DescribeChannelResponse.Builder	topicConfigurationList(Collection<TopicConfiguration> topicConfigurationList)	The list of topic configurations for the channel.
DescribeChannelResponse.Builder	topicConfigurationList(Consumer<TopicConfiguration.Builder>... topicConfigurationList)	The list of topic configurations for the channel.
DescribeChannelResponse.Builder	topicConfigurationList(TopicConfiguration... topicConfigurationList)	The list of topic configurations for the channel.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.kafka.model.KafkaResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

channelArn

DescribeChannelResponse.Builder channelArn(String channelArn)

The Amazon Resource Name (ARN) that uniquely identifies the channel.

Parameters:

channelArn -

The Amazon Resource Name (ARN) that uniquely identifies the channel.

Returns:

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

channelName

DescribeChannelResponse.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.

encryptionConfiguration

DescribeChannelResponse.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

The encryption configuration applied to the channel.

Parameters:

encryptionConfiguration - The encryption configuration applied to the channel.

Returns:

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

encryptionConfiguration

default DescribeChannelResponse.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

The encryption configuration applied to the channel.

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

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

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

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

See Also:

• encryptionConfiguration(EncryptionConfiguration)

icebergDestinationConfiguration

DescribeChannelResponse.Builder icebergDestinationConfiguration(IcebergDestinationConfiguration icebergDestinationConfiguration)

The Apache Iceberg destination for the channel, if configured.

Parameters:

icebergDestinationConfiguration - The Apache Iceberg destination for the channel, if configured.

Returns:

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

icebergDestinationConfiguration

default DescribeChannelResponse.Builder icebergDestinationConfiguration(Consumer<IcebergDestinationConfiguration.Builder> icebergDestinationConfiguration)

The Apache Iceberg destination for the channel, if configured.

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

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

Parameters:

icebergDestinationConfiguration - a consumer that will call methods on IcebergDestinationConfiguration.Builder

Returns:

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

See Also:

• icebergDestinationConfiguration(IcebergDestinationConfiguration)

s3DestinationConfiguration

DescribeChannelResponse.Builder s3DestinationConfiguration(S3DestinationConfiguration s3DestinationConfiguration)

The Amazon S3 destination for the channel, if configured.

Parameters:

s3DestinationConfiguration - The Amazon S3 destination for the channel, if configured.

Returns:

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

s3DestinationConfiguration

default DescribeChannelResponse.Builder s3DestinationConfiguration(Consumer<S3DestinationConfiguration.Builder> s3DestinationConfiguration)

The Amazon S3 destination for the channel, if configured.

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

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

Parameters:

s3DestinationConfiguration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

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

See Also:

• s3DestinationConfiguration(S3DestinationConfiguration)

status

DescribeChannelResponse.Builder status(String status)

The current lifecycle state of the channel.

Parameters:

status - The current lifecycle state of the channel.

Returns:

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

See Also:

• ChannelStatus
• ChannelStatus

status

DescribeChannelResponse.Builder status(ChannelStatus status)

The current lifecycle state of the channel.

Parameters:

status - The current lifecycle state of the channel.

Returns:

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

See Also:

• ChannelStatus
• ChannelStatus

destinationType

DescribeChannelResponse.Builder destinationType(String destinationType)

The type of destination configured for the channel.

Parameters:

destinationType - The type of destination configured for the channel.

Returns:

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

See Also:

• ChannelDestinationType
• ChannelDestinationType

destinationType

DescribeChannelResponse.Builder destinationType(ChannelDestinationType destinationType)

The type of destination configured for the channel.

Parameters:

destinationType - The type of destination configured for the channel.

Returns:

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

See Also:

• ChannelDestinationType
• ChannelDestinationType

creationTime

DescribeChannelResponse.Builder creationTime(Instant creationTime)

The time when the channel was created.

Parameters:

creationTime -

The time when the channel was created.

Returns:

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

topicConfigurationList

DescribeChannelResponse.Builder topicConfigurationList(Collection<TopicConfiguration> topicConfigurationList)

The list of topic configurations for the channel.

Parameters:

topicConfigurationList - The list of topic configurations for the channel.

Returns:

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

topicConfigurationList

DescribeChannelResponse.Builder topicConfigurationList(TopicConfiguration... topicConfigurationList)

The list of topic configurations for the channel.

Parameters:

topicConfigurationList - The list of topic configurations for the channel.

Returns:

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

topicConfigurationList

DescribeChannelResponse.Builder topicConfigurationList(Consumer<TopicConfiguration.Builder>... topicConfigurationList)

The list of topic configurations for the channel.

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

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

Parameters:

topicConfigurationList - a consumer that will call methods on TopicConfiguration.Builder

Returns:

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

See Also:

• topicConfigurationList(java.util.Collection<TopicConfiguration>)

loggingInfo

DescribeChannelResponse.Builder loggingInfo(ChannelLoggingInfo loggingInfo)

The destinations to which the channel publishes operational logs.

Parameters:

loggingInfo - The destinations to which the channel publishes operational logs.

Returns:

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

loggingInfo

default DescribeChannelResponse.Builder loggingInfo(Consumer<ChannelLoggingInfo.Builder> loggingInfo)

The destinations to which the channel publishes operational logs.

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

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

Parameters:

loggingInfo - a consumer that will call methods on ChannelLoggingInfo.Builder

Returns:

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

See Also:

• loggingInfo(ChannelLoggingInfo)

stateInfo

DescribeChannelResponse.Builder stateInfo(ChannelStateInfo stateInfo)

Additional context for the current channel state, populated when the channel is in FAILED.

Parameters:

stateInfo - Additional context for the current channel state, populated when the channel is in FAILED.

Returns:

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

stateInfo

default DescribeChannelResponse.Builder stateInfo(Consumer<ChannelStateInfo.Builder> stateInfo)

Additional context for the current channel state, populated when the channel is in FAILED.

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

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

Parameters:

stateInfo - a consumer that will call methods on ChannelStateInfo.Builder

Returns:

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

See Also:

• stateInfo(ChannelStateInfo)

clusterOperationArn

DescribeChannelResponse.Builder clusterOperationArn(String clusterOperationArn)

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

Parameters:

clusterOperationArn - The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

Returns:

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

tags

DescribeChannelResponse.Builder tags(Map<String,String> tags)

The tags attached to the channel.

Parameters:

tags - The tags attached to the channel.

Returns:

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