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

Reference documentation and code samples for the Google Cloud Data Catalog V1BETA1 API class Google::Cloud::DataCatalog::V1beta1::TagTemplate.

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

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

#display_name=

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

#fields

def fields() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagTemplateField}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagTemplateField}) — Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

    The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.

#fields=

def fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagTemplateField}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagTemplateField}) — Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

    The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagTemplateField}) — Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

    The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.

#name

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

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the tag template in URL format. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

Returns
  • (::String) — The resource name of the tag template in URL format. Example:

    • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    Note that this TagTemplate and its child resources may not actually be stored in the location in this name.