Package software.amazon.awscdk.services.s3tables

Interface CfnTable.SchemaV2FieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.SchemaV2FieldProperty.Jsii$Proxy

Enclosing class:

CfnTable

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

Contains details about a schema field for an Iceberg table that supports nested types (struct, list, map).

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.*;
 Object type;
 SchemaV2FieldProperty schemaV2FieldProperty = SchemaV2FieldProperty.builder()
         .id(123)
         .name("name")
         .required(false)
         .type(type)
         // the properties below are optional
         .doc("doc")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.SchemaV2FieldProperty.Builder	builder()
default String	getDoc()	Optional documentation for the field.
Number	getId()	The unique identifier for the field.
String	getName()	The name of the field.
Object	getRequired()	A Boolean value that specifies whether values are required for each row in this field.
Object	getType()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

@Stability(Stable)
@NotNull
Number getId()

The unique identifier for the field.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the field.

See Also:

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

getRequired

@Stability(Stable)
@NotNull
Object getRequired()

A Boolean value that specifies whether values are required for each row in this field.

Returns union: either Boolean or IResolvable

See Also:

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

getType

@Stability(Stable)
@NotNull
Object getType()

See Also:

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

getDoc

@Stability(Stable)
@Nullable
default String getDoc()

Optional documentation for the field.

See Also:

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

builder

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

Returns:

a CfnTable.SchemaV2FieldProperty.Builder of CfnTable.SchemaV2FieldProperty