Google Cloud Data Catalog V1BETA1 API - Class Google::Cloud::DataCatalog::V1beta1::TagTemplateField (v0.4.0)

Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::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.

#display_name=

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

#is_required

def is_required() -> ::Boolean
Returns
  • (::Boolean) — Whether this is a required field. Defaults to false.

#is_required=

def is_required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether this is a required field. Defaults to false.
Returns
  • (::Boolean) — Whether this is a required field. 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 that this TagTemplateField may not actually be stored in the location in this name.

#order

def order() -> ::Integer
Returns
  • (::Integer) — The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not 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. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
Returns
  • (::Integer) — The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.

#type

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

#type=

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