Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::TagTemplate (v0.11.0)

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

A tag template defines a tag that can have one or more typed fields.

The template is used to create tags that are attached to GCP resources. Tag template roles provide permissions to create, edit, and use the template. For example, see the TagTemplate User role that includes a 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) — Display name for this template. 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) — Display name for this template. 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) — Display name for this template. 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.

#fields

def fields() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}) —

    Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields.

    The keys to this map are tag template field IDs. The IDs have the following limitations:

    • Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
    • Must be at least 1 character and at most 64 characters long.
    • Must start with a letter or underscore.

#fields=

def fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}) —

    Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields.

    The keys to this map are tag template field IDs. The IDs have the following limitations:

    • Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
    • Must be at least 1 character and at most 64 characters long.
    • Must start with a letter or underscore.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1::TagTemplateField}) —

    Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields.

    The keys to this map are tag template field IDs. The IDs have the following limitations:

    • Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_).
    • Must be at least 1 character and at most 64 characters long.
    • Must start with a letter or underscore.

#is_publicly_readable

def is_publicly_readable() -> ::Boolean
Returns
  • (::Boolean) — Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.ListTags] API response.

    Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.

#is_publicly_readable=

def is_publicly_readable=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.ListTags] API response.

    Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.

Returns
  • (::Boolean) — Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in [ListTags][google.cloud.datacatalog.v1.ListTags] API response.

    Additionally, you can search for a public tag by value with a simple search query in addition to using a tag: predicate.

#name

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

    Note: The tag template itself and its child resources 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 template in URL format.

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

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

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