Class Channel
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the channel.static Channel.Builder
builder()
final Instant
When the channel was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The last time when a new message arrived in the channel.final Instant
When the channel was last updated.final String
name()
The name of the channel.final RetentionPeriod
How long, in days, message data is kept for the channel.static Class
<? extends Channel.Builder> final ChannelStatus
status()
The status of the channel.final String
The status of the channel.final ChannelStorage
storage()
Where channel data is stored.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the channel.
- Returns:
- The name of the channel.
-
storage
Where channel data is stored. You can choose one of
serviceManagedS3
orcustomerManagedS3
storage. If not specified, the default isserviceManagedS3
. You can't change this storage option after the channel is created.- Returns:
- Where channel data is stored. You can choose one of
serviceManagedS3
orcustomerManagedS3
storage. If not specified, the default isserviceManagedS3
. You can't change this storage option after the channel is created.
-
arn
The ARN of the channel.
- Returns:
- The ARN of the channel.
-
status
The status of the channel.
If the service returns an enum value that is not available in the current SDK version,
status
will returnChannelStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the channel.
- See Also:
-
statusAsString
The status of the channel.
If the service returns an enum value that is not available in the current SDK version,
status
will returnChannelStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the channel.
- See Also:
-
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
When the channel was created.
- Returns:
- When the channel was created.
-
lastUpdateTime
When the channel was last updated.
- Returns:
- When the channel was last updated.
-
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
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 interfaceToCopyableBuilder<Channel.Builder,
Channel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-