Class: AWSCDK::S3Tables::CfnTable::SchemaFieldProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_tables/cfn_table.rb

Overview

Contains details about a schema field.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, id: nil, required: nil) ⇒ SchemaFieldProperty

Returns a new instance of SchemaFieldProperty.

Parameters:

  • name (String) —

    The name of the field.

  • type (String) —

    The field type.

  • id (Numeric, nil) (defaults to: nil) —

    The unique identifier for the field.

  • required (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 's3_tables/cfn_table.rb', line 1098

def initialize(name:, type:, id: nil, required: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "id") unless @id.nil?
  @required = required
  Jsii::Type.check_type(@required, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "required") unless @required.nil?
end

Instance Attribute Details

#id ⇒ Numeric? (readonly)

The unique identifier for the field.

Returns:

  • (Numeric, nil)

See Also:



1125
1126
1127
 
# File 's3_tables/cfn_table.rb', line 1125

def id
  @id
end

#name ⇒ String (readonly)

The name of the field.

Returns:

  • (String)

See Also:



1113
1114
1115
 
# File 's3_tables/cfn_table.rb', line 1113

def name
  @name
end

#required ⇒ Boolean, ... (readonly)

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:

See Also:



1132
1133
1134
 
# File 's3_tables/cfn_table.rb', line 1132

def required
  @required
end

#type ⇒ String (readonly)

The field type.

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

Returns:

  • (String)

See Also:



1120
1121
1122
 
# File 's3_tables/cfn_table.rb', line 1120

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



1134
1135
1136
1137
1138
1139
1140
1141
 
# File 's3_tables/cfn_table.rb', line 1134

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
    :id => "id",
    :required => "required",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 's3_tables/cfn_table.rb', line 1143

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
    "id" => @id,
    "required" => @required,
  })
  result.compact
end