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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. The resource name for a TagKey. Must be in the format |
↳ parent |
string
Immutable. The resource name of the new TagKey's parent. Must be of the form |
↳ 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 |
Google\Protobuf\Timestamp
Output only. Creation time. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. 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. |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParent
Immutable. The resource name of the new TagKey's parent.
Must be of the form organizations/{org_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Immutable. The resource name of the new TagKey's parent.
Must be of the form organizations/{org_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNamespacedName
Output only. Immutable. Namespaced name of the TagKey.
| Returns | |
|---|---|
| Type | Description |
string | |
setNamespacedName
Output only. Immutable. Namespaced name of the TagKey.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Creation time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Update time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |