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.



4830
4831
4832
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4830

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) 


4806
4807
4808
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4806

def description
  @description
end

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

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

Returns:



4811
4812
4813
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4811

def fields
  @fields
end

#mode ⇒ String

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

Returns:

  • (String) 


4816
4817
4818
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4816

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) 


4823
4824
4825
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4823

def name
  @name
end

#type ⇒ String

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

Returns:

  • (String) 


4828
4829
4830
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4828

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4835
4836
4837
4838
4839
4840
4841
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4835

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