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(value="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 and Description
static interface	Channel.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the channel.
static Channel.Builder	builder()
Instant	creationTime() When the channel was created.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
Channel.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public String name()

The name of the channel.

Returns:

The name of the channel.

arn

public String arn()

The ARN of the channel.

Returns:

The ARN of the channel.

status

public 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 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 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 Instant creationTime()

When the channel was created.

Returns:

When the channel was created.

lastUpdateTime

public Instant lastUpdateTime()

When the channel was last updated.

Returns:

When the channel was last updated.

toBuilder

public Channel.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>

Returns:

a builder for type T

builder

public static Channel.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.