Interface Channel.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Channel.Builder,
,Channel> SdkBuilder<Channel.Builder,
,Channel> SdkPojo
- Enclosing class:
Channel
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the channel.creationTime
(Instant creationTime) When the channel was created.lastMessageArrivalTime
(Instant lastMessageArrivalTime) The last time when a new message arrived in the channel.lastUpdateTime
(Instant lastUpdateTime) When the channel was last updated.The name of the channel.default Channel.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.The status of the channel.status
(ChannelStatus status) The status of the channel.default Channel.Builder
storage
(Consumer<ChannelStorage.Builder> storage) Where channel data is stored.storage
(ChannelStorage storage) Where channel data is stored.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
name
The name of the channel.
- Parameters:
name
- The name of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storage
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:
storage
- 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.
-
storage
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 tostorage(ChannelStorage)
.- Parameters:
storage
- 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:
-
arn
The ARN of the channel.
- Parameters:
arn
- The ARN of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the channel.
- Parameters:
status
- The status of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the channel.
- Parameters:
status
- The status of the channel.- 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.
- Parameters:
retentionPeriod
- How long, in days, message data is kept for the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retentionPeriod
How long, in days, message data is kept for the channel.
This is a convenience method that creates an instance of theRetentionPeriod.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:
-
creationTime
When the channel was created.
- Parameters:
creationTime
- When the channel was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdateTime
When the channel was last updated.
- Parameters:
lastUpdateTime
- When the channel was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastMessageArrivalTime
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the
lastMessageArrivalTime
value is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
- Parameters:
lastMessageArrivalTime
- The last time when a new message arrived in the channel.IoT Analytics updates this value at most once per minute for one channel. Hence, the
lastMessageArrivalTime
value is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-