Class: Aws::S3Tables::Types::SchemaField

Inherits:

Struct

• Object
• Struct
• Aws::S3Tables::Types::SchemaField

Defined in:

gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb

Overview

Contains details about a schema field.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #id ⇒ Integer

  An optional unique identifier for the schema field.

• #name ⇒ String

  The name of the field.

• #required ⇒ Boolean

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

• #type ⇒ String

  The field type.

Instance Attribute Details

#id ⇒ Integer

An optional unique identifier for the schema field. Field IDs are used by Apache Iceberg to track schema evolution and maintain compatibility across schema changes. If not specified, S3 Tables automatically assigns field IDs.

Returns:

• (Integer)

# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 2172

class SchemaField < Struct.new(
  :id,
  :name,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the field.

Returns:

• (String)

# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 2172

class SchemaField < Struct.new(
  :id,
  :name,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

A Boolean value that specifies whether values are required for each row in this field. By default, this is false and null values are allowed in the field. If this is true the field does not allow null values.

Returns:

• (Boolean)

# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 2172

class SchemaField < Struct.new(
  :id,
  :name,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 2172

class SchemaField < Struct.new(
  :id,
  :name,
  :type,
  :required)
  SENSITIVE = []
  include Aws::Structure
end