Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Schema::SchemaField (v0.23.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Schema::SchemaField.

Represents a column field within a table schema.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. User friendly field description. Must be less than or equal to 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User friendly field description. Must be less than or equal to 1024 characters.
Returns
  • (::String) — Optional. User friendly field description. Must be less than or equal to 1024 characters.

#fields

def fields() -> ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>
Returns

#fields=

def fields=(value) -> ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>
Parameter
Returns

#mode

def mode() -> ::Google::Cloud::Dataplex::V1::Schema::Mode
Returns

#mode=

def mode=(value) -> ::Google::Cloud::Dataplex::V1::Schema::Mode
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#type

def type() -> ::Google::Cloud::Dataplex::V1::Schema::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Dataplex::V1::Schema::Type
Parameter
Returns