software.amazon.awssdk.services.timestreamwrite.model

Class Table

java.lang.Object

software.amazon.awssdk.services.timestreamwrite.model.Table

All Implemented Interfaces:

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

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

Represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Table.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name that uniquely identifies this table.
static Table.Builder	builder()
Instant	creationTime() The time when the Timestream table was created.
String	databaseName() The name of the Timestream database that contains this table.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTime() The time when the Timestream table was last updated.
MagneticStoreWriteProperties	magneticStoreWriteProperties() Contains properties to set on the table when enabling magnetic store writes.
RetentionProperties	retentionProperties() The retention duration for the memory store and magnetic store.
Schema	schema() The schema of the table.
List<SdkField<?>>	sdkFields()
static Class<? extends Table.Builder>	serializableBuilderClass()
String	tableName() The name of the Timestream table.
TableStatus	tableStatus() The current state of the table:
String	tableStatusAsString() The current state of the table:
Table.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

arn

public final String arn()

The Amazon Resource Name that uniquely identifies this table.

Returns:

The Amazon Resource Name that uniquely identifies this table.

tableName

public final String tableName()

The name of the Timestream table.

Returns:

The name of the Timestream table.

databaseName

public final String databaseName()

The name of the Timestream database that contains this table.

Returns:

The name of the Timestream database that contains this table.

tableStatus

public final TableStatus tableStatus()

The current state of the table:

• DELETING - The table is being deleted.

• ACTIVE - The table is ready for use.

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

Returns:

The current state of the table:

• DELETING - The table is being deleted.

• ACTIVE - The table is ready for use.

See Also:

TableStatus

tableStatusAsString

public final String tableStatusAsString()

The current state of the table:

• DELETING - The table is being deleted.

• ACTIVE - The table is ready for use.

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

Returns:

The current state of the table:

• DELETING - The table is being deleted.

• ACTIVE - The table is ready for use.

See Also:

TableStatus

retentionProperties

public final RetentionProperties retentionProperties()

The retention duration for the memory store and magnetic store.

Returns:

The retention duration for the memory store and magnetic store.

creationTime

public final Instant creationTime()

The time when the Timestream table was created.

Returns:

The time when the Timestream table was created.

lastUpdatedTime

public final Instant lastUpdatedTime()

The time when the Timestream table was last updated.

Returns:

The time when the Timestream table was last updated.

magneticStoreWriteProperties

public final MagneticStoreWriteProperties magneticStoreWriteProperties()

Contains properties to set on the table when enabling magnetic store writes.

Returns:

Contains properties to set on the table when enabling magnetic store writes.

schema

public final Schema schema()

The schema of the table.

Returns:

The schema of the table.

toBuilder

public Table.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Table.Builder,Table>

builder

public static Table.Builder builder()

serializableBuilderClass

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