com.amazonaws.services.timestreamwrite.model

Class PartitionKey

java.lang.Object

com.amazonaws.services.timestreamwrite.model.PartitionKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PartitionKey
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartitionKey()

Method Summary

Modifier and Type	Method and Description
PartitionKey	clone()
boolean	equals(Object obj)
String	getEnforcementInRecord() The level of enforcement for the specification of a dimension key in ingested records.
String	getName() The name of the attribute used for a dimension key.
String	getType() The type of the partition key.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEnforcementInRecord(String enforcementInRecord) The level of enforcement for the specification of a dimension key in ingested records.
void	setName(String name) The name of the attribute used for a dimension key.
void	setType(String type) The type of the partition key.
String	toString() Returns a string representation of this object.
PartitionKey	withEnforcementInRecord(PartitionKeyEnforcementLevel enforcementInRecord) The level of enforcement for the specification of a dimension key in ingested records.
PartitionKey	withEnforcementInRecord(String enforcementInRecord) The level of enforcement for the specification of a dimension key in ingested records.
PartitionKey	withName(String name) The name of the attribute used for a dimension key.
PartitionKey	withType(PartitionKeyType type) The type of the partition key.
PartitionKey	withType(String type) The type of the partition key.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PartitionKey

public PartitionKey()

Method Detail

setType

public void setType(String type)

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

Parameters:

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

See Also:

PartitionKeyType

getType

public String getType()

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

Returns:

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

See Also:

PartitionKeyType

withType

public PartitionKey withType(String type)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PartitionKeyType

withType

public PartitionKey withType(PartitionKeyType type)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PartitionKeyType

setName

public void setName(String name)

The name of the attribute used for a dimension key.

Parameters:

name - The name of the attribute used for a dimension key.

getName

public String getName()

The name of the attribute used for a dimension key.

Returns:

The name of the attribute used for a dimension key.

withName

public PartitionKey withName(String name)

The name of the attribute used for a dimension key.

Parameters:

name - The name of the attribute used for a dimension key.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnforcementInRecord

public void setEnforcementInRecord(String 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).

Parameters:

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

See Also:

PartitionKeyEnforcementLevel

getEnforcementInRecord

public String getEnforcementInRecord()

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

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

withEnforcementInRecord

public PartitionKey withEnforcementInRecord(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PartitionKeyEnforcementLevel

withEnforcementInRecord

public PartitionKey withEnforcementInRecord(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PartitionKeyEnforcementLevel

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PartitionKey clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.