Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class TagKey.
A TagKey, used to group a set of TagValues.
Generated from protobuf message google.cloud.resourcemanager.v3.TagKey
Namespace
Google \ Cloud \ ResourceManager \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}
, where tag_key_id
is the generated numeric id for the TagKey.
↳ parent
string
Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form organizations/{org_id}
. For a TagKey parented by a Project, its parent can be in the form projects/{project_id}
or projects/{project_number}
.
↳ short_name
string
Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
↳ namespaced_name
string
Output only. Immutable. Namespaced name of the TagKey.
↳ description
string
Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
↳ create_time
↳ update_time
↳ etag
string
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
↳ purpose
int
Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
↳ purpose_data
array| Google\Protobuf\Internal\MapField
Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for Purpose
for formatting of this field. Purpose data cannot be changed once set.
getName
Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}
, where tag_key_id
is the generated numeric id for
the TagKey.
string
setName
Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}
, where tag_key_id
is the generated numeric id for
the TagKey.
var
string
$this
getParent
Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}
. For
a TagKey parented by a Project, its parent can be in the form projects/{project_id}
or projects/{project_number}
.
string
setParent
Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}
. For
a TagKey parented by a Project, its parent can be in the form projects/{project_id}
or projects/{project_number}
.
var
string
$this
getShortName
Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string
setShortName
Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
var
string
$this
getNamespacedName
Output only. Immutable. Namespaced name of the TagKey.
string
setNamespacedName
Output only. Immutable. Namespaced name of the TagKey.
var
string
$this
getDescription
Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
string
setDescription
Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
var
string
$this
getCreateTime
Output only. Creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time.
$this
getUpdateTime
Output only. Update time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time.
$this
getEtag
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string
setEtag
Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
var
string
$this
getPurpose
Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
int
setPurpose
Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
var
int
$this
getPurposeData
Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose
for formatting of this field.
Purpose data cannot be changed once set.
setPurposeData
Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose
for formatting of this field.
Purpose data cannot be changed once set.
$this
