Class: Google::Cloud::Dataplex::V1::Schema::SchemaField

Inherits:

Object

• Object
• Google::Cloud::Dataplex::V1::Schema::SchemaField

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dataplex/v1/metadata.rb

Overview

Represents a column field within a table schema.

Instance Attribute Summary

• #description ⇒ ::String

  Optional.

• #fields ⇒ ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>

  Optional.

• #mode ⇒ ::Google::Cloud::Dataplex::V1::Schema::Mode

  Required.

• #name ⇒ ::String

  Required.

• #type ⇒ ::Google::Cloud::Dataplex::V1::Schema::Type

  Required.

Instance Attribute Details

#description ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 456

class SchemaField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#fields ⇒ ::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>

Returns Optional. Any nested field for complex types.

Returns:

• (::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>) —

  Optional. Any nested field for complex types.

# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 456

class SchemaField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mode ⇒ ::Google::Cloud::Dataplex::V1::Schema::Mode

Returns Required. Additional field semantics.

Returns:

• (::Google::Cloud::Dataplex::V1::Schema::Mode) —

  Required. Additional field semantics.

# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 456

class SchemaField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 456

class SchemaField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::Google::Cloud::Dataplex::V1::Schema::Type

Returns Required. The type of field.

Returns:

• (::Google::Cloud::Dataplex::V1::Schema::Type) —

  Required. The type of field.

# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 456

class SchemaField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end