Package software.amazon.awscdk.services.s3tables

Interface CfnTable.IcebergPartitionFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.IcebergPartitionFieldProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.IcebergPartitionFieldProperty
extends software.amazon.jsii.JsiiSerializable

A partition field specification for an Iceberg table.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3tables.*;
 IcebergPartitionFieldProperty icebergPartitionFieldProperty = IcebergPartitionFieldProperty.builder()
         .name("name")
         .sourceId(123)
         .transform("transform")
         // the properties below are optional
         .fieldId(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.IcebergPartitionFieldProperty.Builder	builder()
default Number	getFieldId()	The partition field ID (auto-assigned starting from 1000 if not specified).
String	getName()	The name of the partition field.
Number	getSourceId()	The source column ID to partition on.
String	getTransform()	The partition transform function (identity, bucket[N], truncate[N], year, month, day, hour).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the partition field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-name

getSourceId

@Stability(Stable)
@NotNull
Number getSourceId()

The source column ID to partition on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-sourceid

getTransform

@Stability(Stable)
@NotNull
String getTransform()

The partition transform function (identity, bucket[N], truncate[N], year, month, day, hour).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-transform

getFieldId

@Stability(Stable)
@Nullable
default Number getFieldId()

The partition field ID (auto-assigned starting from 1000 if not specified).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergpartitionfield.html#cfn-s3tables-table-icebergpartitionfield-fieldid

builder

@Stability(Stable)
static CfnTable.IcebergPartitionFieldProperty.Builder builder()

Returns:

a CfnTable.IcebergPartitionFieldProperty.Builder of CfnTable.IcebergPartitionFieldProperty