Interface CreateChannelRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateChannelRequest.Builder,
,CreateChannelRequest> IoTAnalyticsRequest.Builder
,SdkBuilder<CreateChannelRequest.Builder,
,CreateChannelRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateChannelRequest
-
Method Summary
Modifier and TypeMethodDescriptionchannelName
(String channelName) The name of the channel.default CreateChannelRequest.Builder
channelStorage
(Consumer<ChannelStorage.Builder> channelStorage) Where channel data is stored.channelStorage
(ChannelStorage channelStorage) Where channel data is stored.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.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.retentionPeriod
(RetentionPeriod retentionPeriod) How long, in days, message data is kept for the channel.tags
(Collection<Tag> tags) Metadata which can be used to manage the channel.tags
(Consumer<Tag.Builder>... tags) Metadata which can be used to manage the channel.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, sdkFields
-
Method Details
-
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
Where channel data is stored. You can choose one of
serviceManagedS3
orcustomerManagedS3
storage. If not specified, the default isserviceManagedS3
. You can't change this storage option after the channel is created.- Parameters:
channelStorage
- Where channel data is stored. You can choose one ofserviceManagedS3
orcustomerManagedS3
storage. If not specified, the default isserviceManagedS3
. 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
This is a convenience method that creates an instance of theserviceManagedS3
orcustomerManagedS3
storage. If not specified, the default isserviceManagedS3
. You can't change this storage option after the channel is created.ChannelStorage.Builder
avoiding the need to create one manually viaChannelStorage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochannelStorage(ChannelStorage)
.- Parameters:
channelStorage
- a consumer that will call methods onChannelStorage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. WhencustomerManagedS3
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
This is a convenience method that creates an instance of thecustomerManagedS3
storage is selected, this parameter is ignored.RetentionPeriod.Builder
avoiding the need to create one manually viaRetentionPeriod.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretentionPeriod(RetentionPeriod)
.- Parameters:
retentionPeriod
- a consumer that will call methods onRetentionPeriod.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
Metadata which can be used to manage the channel.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateChannelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-