public static interface Channel.Builder extends SdkPojo, CopyableBuilder<Channel.Builder,Channel>
Modifier and Type | Method and Description |
---|---|
Channel.Builder |
arn(String arn)
The ARN of the channel.
|
Channel.Builder |
creationTime(Instant creationTime)
When the channel was created.
|
Channel.Builder |
lastMessageArrivalTime(Instant lastMessageArrivalTime)
The last time when a new message arrived in the channel.
|
Channel.Builder |
lastUpdateTime(Instant lastUpdateTime)
When the channel was last updated.
|
Channel.Builder |
name(String name)
The name of the channel.
|
default Channel.Builder |
retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)
How long, in days, message data is kept for the channel.
|
Channel.Builder |
retentionPeriod(RetentionPeriod retentionPeriod)
How long, in days, message data is kept for the channel.
|
Channel.Builder |
status(ChannelStatus status)
The status of the channel.
|
Channel.Builder |
status(String status)
The status of the channel.
|
Channel.Builder |
storage(ChannelStorage storage)
Where channel data is stored.
|
default Channel.Builder |
storage(Consumer<ChannelStorage.Builder> storage)
Where channel data is stored.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
Channel.Builder name(String name)
The name of the channel.
name
- The name of the channel.Channel.Builder storage(ChannelStorage storage)
Where channel data is stored. You can choose one of serviceManagedS3
or
customerManagedS3
storage. If not specified, the default is serviceManagedS3
. You
cannot change this storage option after the channel is created.
storage
- Where channel data is stored. You can choose one of serviceManagedS3
or
customerManagedS3
storage. If not specified, the default is serviceManagedS3
. You cannot change this storage option after the channel is created.default Channel.Builder storage(Consumer<ChannelStorage.Builder> storage)
Where channel data is stored. You can choose one of serviceManagedS3
or
customerManagedS3
storage. If not specified, the default is serviceManagedS3
. You
cannot change this storage option after the channel is created.
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 storage(ChannelStorage)
.storage
- a consumer that will call methods on ChannelStorage.Builder
storage(ChannelStorage)
Channel.Builder arn(String arn)
The ARN of the channel.
arn
- The ARN of the channel.Channel.Builder status(String status)
The status of the channel.
status
- The status of the channel.ChannelStatus
,
ChannelStatus
Channel.Builder status(ChannelStatus status)
The status of the channel.
status
- The status of the channel.ChannelStatus
,
ChannelStatus
Channel.Builder retentionPeriod(RetentionPeriod retentionPeriod)
How long, in days, message data is kept for the channel.
retentionPeriod
- How long, in days, message data is kept for the channel.default Channel.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)
How long, in days, message data is kept for the channel.
This is a convenience that creates an instance of theRetentionPeriod.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)
.retentionPeriod
- a consumer that will call methods on RetentionPeriod.Builder
retentionPeriod(RetentionPeriod)
Channel.Builder creationTime(Instant creationTime)
When the channel was created.
creationTime
- When the channel was created.Channel.Builder lastUpdateTime(Instant lastUpdateTime)
When the channel was last updated.
lastUpdateTime
- When the channel was last updated.Channel.Builder lastMessageArrivalTime(Instant lastMessageArrivalTime)
The last time when a new message arrived in the channel.
AWS 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.
lastMessageArrivalTime
- The last time when a new message arrived in the channel.
AWS 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.