Interface Channel.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Channel.Builder,Channel>,SdkBuilder<Channel.Builder,Channel>,SdkPojo
- Enclosing class:
- Channel
public static interface Channel.Builder extends SdkPojo, CopyableBuilder<Channel.Builder,Channel>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Channel.Builderarn(String arn)The ARN of the channel.Channel.BuildercreationTime(Instant creationTime)When the channel was created.Channel.BuilderlastMessageArrivalTime(Instant lastMessageArrivalTime)The last time when a new message arrived in the channel.Channel.BuilderlastUpdateTime(Instant lastUpdateTime)When the channel was last updated.Channel.Buildername(String name)The name of the channel.default Channel.BuilderretentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)How long, in days, message data is kept for the channel.Channel.BuilderretentionPeriod(RetentionPeriod retentionPeriod)How long, in days, message data is kept for the channel.Channel.Builderstatus(String status)The status of the channel.Channel.Builderstatus(ChannelStatus status)The status of the channel.default Channel.Builderstorage(Consumer<ChannelStorage.Builder> storage)Where channel data is stored.Channel.Builderstorage(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 Detail
-
name
Channel.Builder name(String 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
Channel.Builder storage(ChannelStorage storage)
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. 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 ofserviceManagedS3orcustomerManagedS3storage. 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
default Channel.Builder storage(Consumer<ChannelStorage.Builder> storage)
Where channel data is stored. You can choose one of
This is a convenience method that creates an instance of theserviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created.ChannelStorage.Builderavoiding the need to create one manually viaChannelStorage.builder().When the
Consumercompletes,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:
storage(ChannelStorage)
-
arn
Channel.Builder arn(String 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
Channel.Builder status(String 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:
ChannelStatus,ChannelStatus
-
status
Channel.Builder status(ChannelStatus 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:
ChannelStatus,ChannelStatus
-
retentionPeriod
Channel.Builder retentionPeriod(RetentionPeriod 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
default Channel.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)
How long, in days, message data is kept for the channel.
This is a convenience method that creates an instance of theRetentionPeriod.Builderavoiding the need to create one manually viaRetentionPeriod.builder().When the
Consumercompletes,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:
retentionPeriod(RetentionPeriod)
-
creationTime
Channel.Builder creationTime(Instant 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
Channel.Builder lastUpdateTime(Instant 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
Channel.Builder lastMessageArrivalTime(Instant 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
lastMessageArrivalTimevalue 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
lastMessageArrivalTimevalue 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.
-
-