software.amazon.awssdk.services.iotanalytics.model

Class Datastore

java.lang.Object

software.amazon.awssdk.services.iotanalytics.model.Datastore

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Datastore.Builder,Datastore>

@Generated(value="software.amazon.awssdk:codegen")
public final class Datastore
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Datastore.Builder,Datastore>

Information about a data store.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Datastore.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the data store.
static Datastore.Builder	builder()
Instant	creationTime() When the data store was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FileFormatConfiguration	fileFormatConfiguration() Contains the configuration information of file formats.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastMessageArrivalTime() The last time when a new message arrived in the data store.
Instant	lastUpdateTime() The last time the data store was updated.
String	name() The name of the data store.
RetentionPeriod	retentionPeriod() How long, in days, message data is kept for the data store.
List<SdkField<?>>	sdkFields()
static Class<? extends Datastore.Builder>	serializableBuilderClass()
DatastoreStatus	status() The status of a data store:
String	statusAsString() The status of a data store:
DatastoreStorage	storage() Where data store data is stored.
Datastore.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

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 store data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the data store is created.

Returns:

Where data store data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You cannot change this storage option after the 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.

AWS IoT Analytics updates this value at most once per minute for 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.

AWS IoT Analytics updates this value at most once per minute for 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. AWS 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. AWS 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.

toBuilder

public Datastore.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Datastore.Builder,Datastore>

builder

public static Datastore.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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