Show / Hide Table of Contents

Class SchemaFieldProperty

(experimental) Contains details about a schema field.

Inheritance
object
SchemaFieldProperty
Implements
ISchemaFieldProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.S3Tables.Alpha
Assembly: Amazon.CDK.AWS.S3Tables.Alpha.dll
Syntax (csharp)
public class SchemaFieldProperty : ISchemaFieldProperty
Syntax (vb)
Public Class SchemaFieldProperty Implements ISchemaFieldProperty
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3Tables.Alpha;

             var schemaFieldProperty = new SchemaFieldProperty {
                 Name = "name",
                 Type = "type",

                 // the properties below are optional
                 Id = 123,
                 Required = false
             };

Synopsis

Constructors

SchemaFieldProperty()

(experimental) Contains details about a schema field.

Properties

Id

(experimental) The unique identifier for the field.

Name

(experimental) The name of the field.

Required

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

Type

(experimental) The field type.

Constructors

SchemaFieldProperty()

(experimental) Contains details about a schema field.

public SchemaFieldProperty()
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3Tables.Alpha;

             var schemaFieldProperty = new SchemaFieldProperty {
                 Name = "name",
                 Type = "type",

                 // the properties below are optional
                 Id = 123,
                 Required = false
             };

Properties

Id

(experimental) The unique identifier for the field.

public double? Id { get; set; }
Property Value

double?

Remarks

Default: - Auto-assigned by S3 Tables

Stability: Experimental

Name

(experimental) The name of the field.

public string Name { get; set; }
Property Value

string

Remarks

Stability: Experimental

Required

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

public bool? Required { get; set; }
Property Value

bool?

Remarks

By default, this is false and null values are allowed in the field. If this is true, the field does not allow null values.

Default: false

Stability: Experimental

Type

(experimental) The field type.

public string Type { get; set; }
Property Value

string

Remarks

S3 Tables supports all Apache Iceberg primitive types. For more information, see the Apache Iceberg documentation.

Stability: Experimental

Implements

ISchemaFieldProperty
Back to top Generated by DocFX