Interface CreateChannelRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, IoTAnalyticsRequest.Builder, SdkBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateChannelRequest

@Mutable
@NotThreadSafe
public static interface CreateChannelRequest.Builder
extends IoTAnalyticsRequest.Builder, SdkPojo, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Method Summary

Modifier and Type	Method	Description
CreateChannelRequest.Builder	channelName(String channelName)	The name of the channel.
default CreateChannelRequest.Builder	channelStorage(Consumer<ChannelStorage.Builder> channelStorage)	Where channel data is stored.
CreateChannelRequest.Builder	channelStorage(ChannelStorage channelStorage)	Where channel data is stored.
CreateChannelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateChannelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateChannelRequest.Builder	retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)	How long, in days, message data is kept for the channel.
CreateChannelRequest.Builder	retentionPeriod(RetentionPeriod retentionPeriod)	How long, in days, message data is kept for the channel.
CreateChannelRequest.Builder	tags(Collection<Tag> tags)	Metadata which can be used to manage the channel.
CreateChannelRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Metadata which can be used to manage the channel.
CreateChannelRequest.Builder	tags(Tag... tags)	Metadata which can be used to manage the channel.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iotanalytics.model.IoTAnalyticsRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

channelName

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

channelStorage

CreateChannelRequest.Builder channelStorage(ChannelStorage channelStorage)

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

Parameters:

channelStorage - Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3 . You can't change this storage option after the channel is created.

Returns:

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

channelStorage

default CreateChannelRequest.Builder channelStorage(Consumer<ChannelStorage.Builder> channelStorage)

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

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

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

Parameters:

channelStorage - a consumer that will call methods on ChannelStorage.Builder

Returns:

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

See Also:

• channelStorage(ChannelStorage)

retentionPeriod

CreateChannelRequest.Builder retentionPeriod(RetentionPeriod retentionPeriod)

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

Parameters:

retentionPeriod - How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

Returns:

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

retentionPeriod

default CreateChannelRequest.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

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

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

Parameters:

retentionPeriod - a consumer that will call methods on RetentionPeriod.Builder

Returns:

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

See Also:

• retentionPeriod(RetentionPeriod)

tags

CreateChannelRequest.Builder tags(Collection<Tag> tags)

Metadata which can be used to manage the channel.

Parameters:

tags - Metadata which can be used to manage the channel.

Returns:

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

tags

CreateChannelRequest.Builder tags(Tag... tags)

Metadata which can be used to manage the channel.

Parameters:

tags - Metadata which can be used to manage the channel.

Returns:

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

tags

CreateChannelRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata which can be used to manage the channel.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreateChannelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateChannelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.