Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::Tag (v0.23.0)

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

Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#column

def column() -> ::String
Returns
  • (::String) — Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

    To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

#column=

def column=(value) -> ::String
Parameter
  • value (::String) — Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

    To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

Returns
  • (::String) — Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

    To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

#fields

def fields() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}) — Required. Maps the ID of a tag field to its value and additional information about that field.

    Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

#fields=

def fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}) — Required. Maps the ID of a tag field to its value and additional information about that field.

    Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagField}) — Required. Maps the ID of a tag field to its value and additional information about that field.

    Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the tag in URL format where tag ID is a system-generated identifier.

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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the tag in URL format where tag ID is a system-generated identifier.

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

Returns
  • (::String) — The resource name of the tag in URL format where tag ID is a system-generated identifier.

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

#template

def template() -> ::String
Returns
  • (::String) — Required. The resource name of the tag template this tag uses. Example:

    projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

    This field cannot be modified after creation.

#template=

def template=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the tag template this tag uses. Example:

    projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

    This field cannot be modified after creation.

Returns
  • (::String) — Required. The resource name of the tag template this tag uses. Example:

    projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

    This field cannot be modified after creation.

#template_display_name

def template_display_name() -> ::String
Returns
  • (::String) — Output only. The display name of the tag template.