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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<ChannelSummary.Builder,ChannelSummary>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.