Google Cloud Resource Manager V3 Client - Class TagValue (0.5.0)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. Resource name for TagValue in the format tagValues/456.

↳ parent string

Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form tagKeys/{tag_key_id}.

↳ 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 {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}.

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

setName

Immutable. Resource name for TagValue in the format tagValues/456.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParent

Immutable. The resource name of the new TagValue's parent TagKey.

Must be of the form tagKeys/{tag_key_id}.

Returns
TypeDescription
string

setParent

Immutable. The resource name of the new TagValue's parent TagKey.

Must be of the form tagKeys/{tag_key_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. User-assigned description of the TagValue.

Must not exceed 256 characters. Read-write.

Returns
TypeDescription
string

setDescription

Optional. User-assigned description of the TagValue.

Must not exceed 256 characters. Read-write.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Update time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this