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

Class Channel

java.lang.Object

software.amazon.awssdk.services.iotanalytics.model.Channel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Channel.Builder,Channel>

@Generated("software.amazon.awssdk:codegen")
public final class Channel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Channel.Builder,Channel>

A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Channel.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN of the channel.
static Channel.Builder	builder()
Instant	creationTime()	When the channel was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastMessageArrivalTime()	The last time when a new message arrived in the channel.
Instant	lastUpdateTime()	When the channel was last updated.
String	name()	The name of the channel.
RetentionPeriod	retentionPeriod()	How long, in days, message data is kept for the channel.
List<SdkField<?>>	sdkFields()
static Class<? extends Channel.Builder>	serializableBuilderClass()
ChannelStatus	status()	The status of the channel.
String	statusAsString()	The status of the channel.
ChannelStorage	storage()	Where channel data is stored.
Channel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the channel.

Returns:

The name of the channel.

storage

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

Returns:

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.

arn

public final String arn()

The ARN of the channel.

Returns:

The ARN of the channel.

status

public final ChannelStatus status()

The status of the channel.

If the service returns an enum value that is not available in the current SDK version, status will return ChannelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the channel.

See Also:

ChannelStatus

statusAsString

public final String statusAsString()

The status of the channel.

If the service returns an enum value that is not available in the current SDK version, status will return ChannelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the channel.

See Also:

ChannelStatus

retentionPeriod

public final RetentionPeriod retentionPeriod()

How long, in days, message data is kept for the channel.

Returns:

How long, in days, message data is kept for the channel.

creationTime

public final Instant creationTime()

When the channel was created.

Returns:

When the channel was created.

lastUpdateTime

public final Instant lastUpdateTime()

When the channel was last updated.

Returns:

When the channel was last updated.

lastMessageArrivalTime

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

Returns:

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.

toBuilder

public Channel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>

builder

public static Channel.Builder builder()

serializableBuilderClass

public static Class<? extends Channel.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo