Package software.amazon.awssdk.services.timestreamwrite.model

Class PartitionKey

java.lang.Object

software.amazon.awssdk.services.timestreamwrite.model.PartitionKey

All Implemented Interfaces:

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

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

An attribute used in partitioning data in a table. A dimension key partitions data using the values of the dimension specified by the dimension-name as partition key, while a measure key partitions data using measure names (values of the 'measure_name' column).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PartitionKey.Builder

Method Summary

Modifier and Type	Method	Description
static PartitionKey.Builder	builder()
PartitionKeyEnforcementLevel	enforcementInRecord()	The level of enforcement for the specification of a dimension key in ingested records.
String	enforcementInRecordAsString()	The level of enforcement for the specification of a dimension key in ingested records.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the attribute used for a dimension key.
List<SdkField<?>>	sdkFields()
static Class<? extends PartitionKey.Builder>	serializableBuilderClass()
PartitionKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PartitionKeyType	type()	The type of the partition key.
String	typeAsString()	The type of the partition key.

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

type

public final PartitionKeyType type()

The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

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

Returns:

The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

See Also:

PartitionKeyType

typeAsString

public final String typeAsString()

The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

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

Returns:

The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

See Also:

PartitionKeyType

name

public final String name()

The name of the attribute used for a dimension key.

Returns:

The name of the attribute used for a dimension key.

enforcementInRecord

public final PartitionKeyEnforcementLevel enforcementInRecord()

The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

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

Returns:

The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

See Also:

PartitionKeyEnforcementLevel

enforcementInRecordAsString

public final String enforcementInRecordAsString()

The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

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

Returns:

The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

See Also:

PartitionKeyEnforcementLevel

toBuilder

public PartitionKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PartitionKey.Builder,PartitionKey>

builder

public static PartitionKey.Builder builder()

serializableBuilderClass

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