Google Cloud Resource Manager V3 Client - Class ListTagHoldsRequest (0.8.5)

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

The request message for listing the TagHolds under a TagValue.

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

Namespace

Google \ Cloud \ ResourceManager \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the parent TagValue. Must be of the form: tagValues/{tag-value-id}.
↳ page_size int

Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.
↳ page_token string

Optional. A pagination token returned from a previous call to ListTagHolds that indicates where this listing should continue from.
↳ filter string

Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the holder and origin fields are supported for filtering. Currently only AND syntax is supported. Some example queries are: * holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group * origin = 35678234 * holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234

getParent

Required. The resource name of the parent TagValue. Must be of the form: tagValues/{tag-value-id}.

Returns
Type Description
string

setParent

Required. The resource name of the parent TagValue. Must be of the form: tagValues/{tag-value-id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.

Returns
Type Description
int

setPageSize

Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A pagination token returned from a previous call to ListTagHolds that indicates where this listing should continue from.

Returns
Type Description
string

setPageToken

Optional. A pagination token returned from a previous call to ListTagHolds that indicates where this listing should continue from.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the holder and origin fields are supported for filtering. Currently only AND syntax is supported. Some example queries are:

  • holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group
  • origin = 35678234
  • holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234
Returns
Type Description
string

setFilter

Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the holder and origin fields are supported for filtering. Currently only AND syntax is supported. Some example queries are:

  • holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group
  • origin = 35678234
  • holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the parent TagValue. Must be of the form: tagValues/{tag-value-id}. Please see Google\Cloud\ResourceManager\V3\TagHoldsClient::tagValueName() for help formatting this field.
Returns
Type Description
Google\Cloud\ResourceManager\V3\ListTagHoldsRequest