Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class PolicyTag.
Denotes one policy tag in a taxonomy, for example, SSN.
Policy tags can be defined in a hierarchy. For example:
+ Geolocation
+ LatLong
+ City
+ ZipCode
Where the "Geolocation" policy tag contains three children.
Generated from protobuf message google.cloud.datacatalog.v1.PolicyTag
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs. |
↳ display_name |
string
Required. User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8. |
↳ description |
string
Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8. |
↳ parent_policy_tag |
string
Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty. |
↳ child_policy_tags |
array
Output only. Resource names of child policy tags of this policy tag. |
getName
Output only. Resource name of this policy tag in the URL format.
The policy tag manager generates unique taxonomy IDs and policy tag IDs.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of this policy tag in the URL format.
The policy tag manager generates unique taxonomy IDs and policy tag IDs.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. User-defined name of this policy tag.
The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. User-defined name of this policy tag.
The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of this policy tag. If not set, defaults to empty.
The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of this policy tag. If not set, defaults to empty.
The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParentPolicyTag
Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.
For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
| Returns | |
|---|---|
| Type | Description |
string | |
setParentPolicyTag
Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.
For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getChildPolicyTags
Output only. Resource names of child policy tags of this policy tag.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setChildPolicyTags
Output only. Resource names of child policy tags of this policy tag.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |