Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class TagValue.
A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.
Generated from protobuf message google.cloud.resourcemanager.v3.TagValue
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. Resource name for TagValue in the format |
↳ parent |
string
Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form |
↳ short_name |
string
Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. |
↳ namespaced_name |
string
Output only. The namespaced name of the TagValue. Can be in the form |
↳ description |
string
Optional. User-assigned description of the TagValue. 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 UpdateTagValueRequest for details. |
getName
Immutable. Resource name for TagValue in the format tagValues/456.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Immutable. Resource name for TagValue in the format tagValues/456.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParent
Immutable. The resource name of the new TagValue's parent TagKey.
Must be of the form tagKeys/{tag_key_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Immutable. The resource name of the new TagValue's parent TagKey.
Must be of the form tagKeys/{tag_key_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getShortName
Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey.
The short name must be 63 characters or less, 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. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey.
The short name must be 63 characters or less, 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. The namespaced name of the TagValue. Can be in the form
{organization_id}/{tag_key_short_name}/{tag_value_short_name} or
{project_id}/{tag_key_short_name}/{tag_value_short_name} or
{project_number}/{tag_key_short_name}/{tag_value_short_name}.
| Returns | |
|---|---|
| Type | Description |
string | |
setNamespacedName
Output only. The namespaced name of the TagValue. Can be in the form
{organization_id}/{tag_key_short_name}/{tag_value_short_name} or
{project_id}/{tag_key_short_name}/{tag_value_short_name} or
{project_number}/{tag_key_short_name}/{tag_value_short_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. User-assigned description of the TagValue.
Must not exceed 256 characters. Read-write.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. User-assigned description of the TagValue.
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 UpdateTagValueRequest 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 UpdateTagValueRequest for details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |