Package software.amazon.awssdk.services.iotanalytics.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DatastoreSummary.Builder

Method Summary

Modifier and Type	Method	Description
static DatastoreSummary.Builder	builder()
Instant	creationTime()	When the data store was created.
String	datastoreName()	The name of the data store.
DatastorePartitions	datastorePartitions()	Contains information about the partition dimensions in a data store.
DatastoreStorageSummary	datastoreStorage()	Where data in a data store is stored.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FileFormatType	fileFormatType()	The file format of the data in the data store.
String	fileFormatTypeAsString()	The file format of the data in the data store.
<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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DatastoreSummary.Builder>	serializableBuilderClass()
DatastoreStatus	status()	The status of the data store.
String	statusAsString()	The status of the data store.
DatastoreSummary.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

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:

DatastoreStatus

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:

DatastoreStatus

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:

FileFormatType

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:

FileFormatType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DatastoreSummary.Builder,DatastoreSummary>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo