Google Cloud Data Catalog V1 Client - Class Tag (1.6.0)

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

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

Namespace

Google \ Cloud \ DataCatalog \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

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

Output only. The display name of the tag template.

↳ column 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 array|Google\Protobuf\Internal\MapField

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.

getName

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

setName

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTemplate

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

setTemplate

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTemplateDisplayName

Output only. The display name of the tag template.

Returns
TypeDescription
string

setTemplateDisplayName

Output only. The display name of the tag template.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getColumn

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

hasColumn

setColumn

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFields

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

setFields

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getScope

Returns
TypeDescription
string