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

Class ChannelSummary

java.lang.Object

software.amazon.awssdk.services.iotanalytics.model.ChannelSummary

All Implemented Interfaces:

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

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

A summary of information about a channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChannelSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ChannelSummary.Builder	builder()
String	channelName()	The name of the channel.
ChannelStorageSummary	channelStorage()	Where channel data is stored.
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()	The last time the channel was updated.
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelSummary.Builder>	serializableBuilderClass()
ChannelStatus	status()	The status of the channel.
String	statusAsString()	The status of the channel.
ChannelSummary.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

channelName

public final String channelName()

The name of the channel.

Returns:

The name of the channel.

channelStorage

public final ChannelStorageSummary channelStorage()

Where channel data is stored.

Returns:

Where channel data is stored.

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

creationTime

public final Instant creationTime()

When the channel was created.

Returns:

When the channel was created.

lastUpdateTime

public final Instant lastUpdateTime()

The last time the channel was updated.

Returns:

The last time the channel was 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 ChannelSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelSummary.Builder,ChannelSummary>

builder

public static ChannelSummary.Builder builder()

serializableBuilderClass

public static Class<? extends ChannelSummary.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