software.amazon.awssdk.services.iotanalytics.model

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

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.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

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 serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

Parameters:

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

storage

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 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 storage(ChannelStorage).

Parameters:

storage - 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:

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 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)

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