Package software.amazon.awscdk.services.glue.alpha

Interface PartitionIndex

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PartitionIndex.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:25.627Z")
@Stability(Experimental)
public interface PartitionIndex
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties of a Partition Index.

Example:

 Table myTable;
 myTable.addPartitionIndex(PartitionIndex.builder()
         .indexName("my-index")
         .keyNames(List.of("year"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PartitionIndex.Builder	A builder for PartitionIndex
static final class	PartitionIndex.Jsii$Proxy	An implementation for PartitionIndex

Method Summary

Modifier and Type	Method	Description
static PartitionIndex.Builder	builder()
default String	getIndexName()	(experimental) The name of the partition index.
List<String>	getKeyNames()	(experimental) The partition key names that comprise the partition index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKeyNames

@Stability(Experimental)
@NotNull
List<String> getKeyNames()

(experimental) The partition key names that comprise the partition index.

The names must correspond to a name in the table's partition keys.

getIndexName

@Stability(Experimental)
@Nullable
default String getIndexName()

(experimental) The name of the partition index.

Default: - a name will be generated for you.

builder

@Stability(Experimental)
static PartitionIndex.Builder builder()

Returns:

a PartitionIndex.Builder of PartitionIndex