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.



5981
5982
5983
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5981

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) 


5957
5958
5959
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5957

def description
  @description
end

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

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

Returns:



5962
5963
5964
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5962

def fields
  @fields
end

#mode ⇒ String

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

Returns:

  • (String) 


5967
5968
5969
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5967

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) 


5974
5975
5976
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5974

def name
  @name
end

#type ⇒ String

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

Returns:

  • (String) 


5979
5980
5981
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5979

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5986
5987
5988
5989
5990
5991
5992
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 5986

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