Class Datastore

    • Method Detail

      • name

        public final String name()

        The name of the data store.

        Returns:
        The name of the data store.
      • storage

        public final DatastoreStorage storage()

        Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.

        Returns:
        Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.
      • arn

        public final String arn()

        The ARN of the data store.

        Returns:
        The ARN of the data store.
      • status

        public final DatastoreStatus status()

        The status of a data store:

        CREATING

        The data store is being created.

        ACTIVE

        The data store has been created and can be used.

        DELETING

        The data store is being deleted.

        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 a data store:

        CREATING

        The data store is being created.

        ACTIVE

        The data store has been created and can be used.

        DELETING

        The data store is being deleted.

        See Also:
        DatastoreStatus
      • statusAsString

        public final String statusAsString()

        The status of a data store:

        CREATING

        The data store is being created.

        ACTIVE

        The data store has been created and can be used.

        DELETING

        The data store is being deleted.

        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 a data store:

        CREATING

        The data store is being created.

        ACTIVE

        The data store has been created and can be used.

        DELETING

        The data store is being deleted.

        See Also:
        DatastoreStatus
      • retentionPeriod

        public final RetentionPeriod retentionPeriod()

        How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

        Returns:
        How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.
      • 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.

      • fileFormatConfiguration

        public final FileFormatConfiguration fileFormatConfiguration()

        Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.

        The default file format is JSON. You can specify only one format.

        You can't change the file format after you create the data store.

        Returns:
        Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.

        The default file format is JSON. You can specify only one format.

        You can't change the file format after you create the data store.

      • 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)