Google Cloud Data Catalog V1 Client - Class TagTemplate (1.4.2)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class 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 Google Cloud 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.

Generated from protobuf message google.cloud.datacatalog.v1.TagTemplate

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name 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.

↳ display_name 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.

↳ is_publicly_readable bool

Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in 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.

↳ fields array|Google\Protobuf\Internal\MapField

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.

getName

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
TypeDescription
string

setName

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

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
TypeDescription
string

setDisplayName

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIsPubliclyReadable

Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in 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
TypeDescription
bool

setIsPubliclyReadable

Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in 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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getFields

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
TypeDescription
Google\Protobuf\Internal\MapField

setFields

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.
Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this