Package software.amazon.awssdk.services.iotanalytics.model

Interface ChannelSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ChannelSummary.Builder,ChannelSummary>, SdkBuilder<ChannelSummary.Builder,ChannelSummary>, SdkPojo

Enclosing class:

ChannelSummary

public static interface ChannelSummary.Builder
extends SdkPojo, CopyableBuilder<ChannelSummary.Builder,ChannelSummary>

Method Summary

Modifier and Type	Method	Description
ChannelSummary.Builder	channelName(String channelName)	The name of the channel.
default ChannelSummary.Builder	channelStorage(Consumer<ChannelStorageSummary.Builder> channelStorage)	Where channel data is stored.
ChannelSummary.Builder	channelStorage(ChannelStorageSummary channelStorage)	Where channel data is stored.
ChannelSummary.Builder	creationTime(Instant creationTime)	When the channel was created.
ChannelSummary.Builder	lastMessageArrivalTime(Instant lastMessageArrivalTime)	The last time when a new message arrived in the channel.
ChannelSummary.Builder	lastUpdateTime(Instant lastUpdateTime)	The last time the channel was updated.
ChannelSummary.Builder	status(String status)	The status of the channel.
ChannelSummary.Builder	status(ChannelStatus status)	The status of the channel.

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

channelName

ChannelSummary.Builder channelName(String 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

ChannelSummary.Builder channelStorage(ChannelStorageSummary channelStorage)

Where channel data is stored.

Parameters:

channelStorage - Where channel data is stored.

Returns:

Returns a reference to this object so that method calls can be chained together.

channelStorage

default ChannelSummary.Builder channelStorage(Consumer<ChannelStorageSummary.Builder> channelStorage)

Where channel data is stored.

This is a convenience method that creates an instance of the ChannelStorageSummary.Builder avoiding the need to create one manually via ChannelStorageSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to channelStorage(ChannelStorageSummary).

Parameters:

channelStorage - a consumer that will call methods on ChannelStorageSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

channelStorage(ChannelStorageSummary)

status

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

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

creationTime

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

ChannelSummary.Builder lastUpdateTime(Instant lastUpdateTime)

The last time the channel was updated.

Parameters:

lastUpdateTime - The last time the channel was updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastMessageArrivalTime

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