Package software.amazon.awscdk.services.scn

Interface CfnDataset.SchemaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataset.SchemaProperty.Jsii$Proxy

Enclosing class:

CfnDataset

@Stability(Stable)
public static interface CfnDataset.SchemaProperty
extends software.amazon.jsii.JsiiSerializable

The schema of the dataset.

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.scn.*;
 SchemaProperty schemaProperty = SchemaProperty.builder()
         .fields(List.of(DataLakeDatasetSchemaFieldProperty.builder()
                 .isRequired(false)
                 .name("name")
                 .type("type")
                 .build()))
         .name("name")
         // the properties below are optional
         .primaryKeys(List.of(DataLakeDatasetPrimaryKeyFieldProperty.builder()
                 .name("name")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-schema.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataset.SchemaProperty.Builder	builder()
Object	getFields()	The list of field details of the dataset schema.
String	getName()	The name of the dataset schema.
default Object	getPrimaryKeys()	The list of primary key fields for the dataset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFields

@Stability(Stable)
@NotNull
Object getFields()

The list of field details of the dataset schema.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataset.DataLakeDatasetSchemaFieldProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-schema.html#cfn-scn-dataset-schema-fields

getName

@Stability(Stable)
@NotNull
String getName()

The name of the dataset schema.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-schema.html#cfn-scn-dataset-schema-name

getPrimaryKeys

@Stability(Stable)
@Nullable
default Object getPrimaryKeys()

The list of primary key fields for the dataset.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataset.DataLakeDatasetPrimaryKeyFieldProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scn-dataset-schema.html#cfn-scn-dataset-schema-primarykeys

builder

@Stability(Stable)
static CfnDataset.SchemaProperty.Builder builder()

Returns:

a CfnDataset.SchemaProperty.Builder of CfnDataset.SchemaProperty