Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::TagTemplateField (v0.22.0)

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::TagTemplateField.

The template for an individual field within a tag template.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — The description for this field. Defaults to an empty string.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — The description for this field. Defaults to an empty string.
Returns
  • (::String) — The description for this field. Defaults to an empty string.

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name for this field. Defaults to an empty string.

    The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name for this field. Defaults to an empty string.

    The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

Returns
  • (::String) — The display name for this field. Defaults to an empty string.

    The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

#is_required

def is_required() -> ::Boolean
Returns
  • (::Boolean) — If true, this field is required. Defaults to false.

#is_required=

def is_required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, this field is required. Defaults to false.
Returns
  • (::Boolean) — If true, this field is required. Defaults to false.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the tag template field in URL format. Example:

    projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}

    Note: The tag template field itself might not be stored in the location specified in its name.

    The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.

#order

def order() -> ::Integer
Returns
  • (::Integer) — The order of this field with respect to other fields in this tag template.

    For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.

#order=

def order=(value) -> ::Integer
Parameter
  • value (::Integer) — The order of this field with respect to other fields in this tag template.

    For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.

Returns
  • (::Integer) — The order of this field with respect to other fields in this tag template.

    For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.

#type

def type() -> ::Google::Cloud::DataCatalog::V1::FieldType
Returns

#type=

def type=(value) -> ::Google::Cloud::DataCatalog::V1::FieldType
Parameter
Returns