Class: Aws::S3Tables::Types::IcebergSortField

Inherits:

Struct

• Object
• Struct
• Aws::S3Tables::Types::IcebergSortField

Defined in:

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

Overview

Defines a single sort field in an Iceberg sort order specification.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #direction ⇒ String

  The sort direction.

• #null_order ⇒ String

  Specifies how null values are ordered.

• #source_id ⇒ Integer

  The ID of the source schema field to sort by.

• #transform ⇒ String

  The transform to apply to the source field before sorting.

Instance Attribute Details

#direction ⇒ String

The sort direction. Valid values are asc for ascending order or desc for descending order.

Returns:

• (String)

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

class IcebergSortField < Struct.new(
  :source_id,
  :transform,
  :direction,
  :null_order)
  SENSITIVE = []
  include Aws::Structure
end

#null_order ⇒ String

Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.

Returns:

• (String)

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

class IcebergSortField < Struct.new(
  :source_id,
  :transform,
  :direction,
  :null_order)
  SENSITIVE = []
  include Aws::Structure
end

#source_id ⇒ Integer

The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.

Returns:

• (Integer)

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

class IcebergSortField < Struct.new(
  :source_id,
  :transform,
  :direction,
  :null_order)
  SENSITIVE = []
  include Aws::Structure
end

#transform ⇒ String

The transform to apply to the source field before sorting. Use identity to sort by the field value directly, or specify other transforms as needed.

Returns:

• (String)

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

class IcebergSortField < Struct.new(
  :source_id,
  :transform,
  :direction,
  :null_order)
  SENSITIVE = []
  include Aws::Structure
end