Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1SchemaSchemaField

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

Represents a column field within a table schema.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1SchemaSchemaField

Returns a new instance of GoogleCloudDataplexV1SchemaSchemaField.



4182
4183
4184
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4182

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

Optional. User friendly field description. Must be less than or equal to 1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


4158
4159
4160
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4158

def description
  @description
end

#fields ⇒ Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1SchemaSchemaField>

Optional. Any nested field for complex types. Corresponds to the JSON property fields

Returns:



4163
4164
4165
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4163

def fields
  @fields
end

#mode ⇒ String

Required. Additional field semantics. Corresponds to the JSON property mode

Returns:

  • (String) 


4168
4169
4170
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4168

def mode
  @mode
end

#name ⇒ String

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore. Corresponds to the JSON property name

Returns:

  • (String) 


4175
4176
4177
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4175

def name
  @name
end

#type ⇒ String

Required. The type of field. Corresponds to the JSON property type

Returns:

  • (String) 


4180
4181
4182
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4180

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4187
4188
4189
4190
4191
4192
4193
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4187

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @fields = args[:fields] if args.key?(:fields)
  @mode = args[:mode] if args.key?(:mode)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
end