Class: Aws::Glue::Types::IcebergStructField

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::IcebergStructField

Defined in:

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

Overview

Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #doc ⇒ String

  Optional documentation or description text that provides additional context about the purpose and usage of this field.

• #id ⇒ Integer

  The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

• #initial_default ⇒ Hash, ...

  Default value used to populate the field's value for all records that were written before the field was added to the schema.

• #name ⇒ String

  The name of the field as it appears in the table schema and query operations.

• #required ⇒ Boolean

  Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

• #type ⇒ Hash, ...

  The data type definition for this field, specifying the structure and format of the data it contains.

• #write_default ⇒ Hash, ...

  Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value.

Instance Attribute Details

#doc ⇒ String

Optional documentation or description text that provides additional context about the purpose and usage of this field.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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

#id ⇒ Integer

The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

Returns:

• (Integer)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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

#initial_default ⇒ Hash, ...

Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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

#name ⇒ String

The name of the field as it appears in the table schema and query operations.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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

#required ⇒ Boolean

Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

Returns:

• (Boolean)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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

#type ⇒ Hash, ...

The data type definition for this field, specifying the structure and format of the data it contains.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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

#write_default ⇒ Hash, ...

Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 16583

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