Class DatastoreSummary

java.lang.Object
software.amazon.awssdk.services.iotanalytics.model.DatastoreSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatastoreSummary.Builder,DatastoreSummary>
@Generated("software.amazon.awssdk:codegen") public final class DatastoreSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatastoreSummary.Builder,DatastoreSummary>

A summary of information about a data store.

See Also:

  • Method Details

    • datastoreName

      public final String datastoreName()

      The name of the data store.

      Returns:
      The name of the data store.

    • datastoreStorage

      public final DatastoreStorageSummary datastoreStorage()

      Where data in a data store is stored.

      Returns:
      Where data in a data store is stored.

    • status

      public final DatastoreStatus status()

      The status of the data store.

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

      Returns:
      The status of the data store.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the data store.

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

      Returns:
      The status of the data store.
      See Also:

    • creationTime

      public final Instant creationTime()

      When the data store was created.

      Returns:
      When the data store was created.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The last time the data store was updated.

      Returns:
      The last time the data store was updated.

    • lastMessageArrivalTime

      public final Instant lastMessageArrivalTime()

      The last time when a new message arrived in the data store.

      IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. 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 data store.

      IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.

      This feature only applies to messages that arrived in the data store after October 23, 2020.

    • fileFormatType

      public final FileFormatType fileFormatType()

      The file format of the data in the data store.

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

      Returns:
      The file format of the data in the data store.
      See Also:

    • fileFormatTypeAsString

      public final String fileFormatTypeAsString()

      The file format of the data in the data store.

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

      Returns:
      The file format of the data in the data store.
      See Also:

    • datastorePartitions

      public final DatastorePartitions datastorePartitions()

      Contains information about the partition dimensions in a data store.

      Returns:
      Contains information about the partition dimensions in a data store.

    • toBuilder

      public DatastoreSummary.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<DatastoreSummary.Builder,DatastoreSummary>
      Returns:
      a builder for type T

    • builder

      public static DatastoreSummary.Builder builder()

    • serializableBuilderClass

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