Google Cloud Resource Manager V3 Client - Class TagHold (1.0.2)

Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class TagHold.

A TagHold represents the use of a TagValue that is not captured by TagBindings. If a TagValue has any TagHolds, deletion will be blocked.

This resource is intended to be created in the same cloud location as the holder.

Generated from protobuf message google.cloud.resourcemanager.v3.TagHold

Namespace

Google \ Cloud \ ResourceManager \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The resource name of a TagHold. This is a String of the form: tagValues/{tag-value-id}/tagHolds/{tag-hold-id} (e.g. tagValues/123/tagHolds/456). This resource name is generated by the server.
↳ holder string

Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g. //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group
↳ origin string

Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g. migs-35678234
↳ help_link string

Optional. A URL where an end user can learn more about removing this hold. E.g. https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
↳ create_time Google\Protobuf\Timestamp

Output only. The time this TagHold was created.

getName

Output only. The resource name of a TagHold. This is a String of the form: tagValues/{tag-value-id}/tagHolds/{tag-hold-id} (e.g. tagValues/123/tagHolds/456). This resource name is generated by the server.

Returns
Type Description
string

setName

Output only. The resource name of a TagHold. This is a String of the form: tagValues/{tag-value-id}/tagHolds/{tag-hold-id} (e.g. tagValues/123/tagHolds/456). This resource name is generated by the server.

Parameter
Name Description
var string
Returns
Type Description
$this

getHolder

Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g.

//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group

Returns
Type Description
string

setHolder

Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g.

//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group

Parameter
Name Description
var string
Returns
Type Description
$this

getOrigin

Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g.

migs-35678234

Returns
Type Description
string

setOrigin

Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g.

migs-35678234

Parameter
Name Description
var string
Returns
Type Description
$this

getHelpLink

Optional. A URL where an end user can learn more about removing this hold.

E.g. https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing

Returns
Type Description
string

setHelpLink

Optional. A URL where an end user can learn more about removing this hold.

E.g. https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time this TagHold was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time this TagHold was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this