Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListGroupsRequest.
TheListGrouprequest.
Generated from protobuf messagegoogle.monitoring.v3.ListGroupsRequest
Namespace
Google \ Cloud \ Monitoring \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Theprojectwhose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
↳ children_of_group
string
A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whoseparent_namefield contains the group name. If no groups have this parent, the results are empty.
↳ ancestors_of_group
string
A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
↳ descendants_of_group
string
A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by thechildren_of_groupfilter, and includes children-of-children, and so forth.
↳ page_size
int
A positive number that is the maximum number of results to return.
↳ page_token
string
If this field is not empty then it must contain thenext_page_tokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
getName
Required. Theprojectwhose
groups are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Returns
Type
Description
string
setName
Required. Theprojectwhose
groups are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getChildrenOfGroup
A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups whoseparent_namefield contains the group
name. If no groups have this parent, the results are empty.
Returns
Type
Description
string
hasChildrenOfGroup
setChildrenOfGroup
A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups whoseparent_namefield contains the group
name. If no groups have this parent, the results are empty.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAncestorsOfGroup
A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups that are ancestors of the specified group.
The groups are returned in order, starting with the immediate parent and
ending with the most distant ancestor. If the specified group has no
immediate parent, the results are empty.
Returns
Type
Description
string
hasAncestorsOfGroup
setAncestorsOfGroup
A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups that are ancestors of the specified group.
The groups are returned in order, starting with the immediate parent and
ending with the most distant ancestor. If the specified group has no
immediate parent, the results are empty.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescendantsOfGroup
A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns the descendants of the specified group. This is a superset of
the results returned by thechildren_of_groupfilter, and includes
children-of-children, and so forth.
Returns
Type
Description
string
hasDescendantsOfGroup
setDescendantsOfGroup
A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns the descendants of the specified group. This is a superset of
the results returned by thechildren_of_groupfilter, and includes
children-of-children, and so forth.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
A positive number that is the maximum number of results to return.
Returns
Type
Description
int
setPageSize
A positive number that is the maximum number of results to return.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
If this field is not empty then it must contain thenext_page_tokenvalue
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
Returns
Type
Description
string
setPageToken
If this field is not empty then it must contain thenext_page_tokenvalue
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Returns
Type
Description
string
static::build
Parameter
Name
Description
name
string
Required. Theprojectwhose
groups are to be listed. The format is:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Stackdriver Monitoring V3 Client - Class ListGroupsRequest (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-monitoring/latest/V3.ListGroupsRequest)\n- [2.1.1](/php/docs/reference/cloud-monitoring/2.1.1/V3.ListGroupsRequest)\n- [2.0.1](/php/docs/reference/cloud-monitoring/2.0.1/V3.ListGroupsRequest)\n- [1.12.1](/php/docs/reference/cloud-monitoring/1.12.1/V3.ListGroupsRequest)\n- [1.11.1](/php/docs/reference/cloud-monitoring/1.11.1/V3.ListGroupsRequest)\n- [1.10.3](/php/docs/reference/cloud-monitoring/1.10.3/V3.ListGroupsRequest)\n- [1.9.0](/php/docs/reference/cloud-monitoring/1.9.0/V3.ListGroupsRequest)\n- [1.8.0](/php/docs/reference/cloud-monitoring/1.8.0/V3.ListGroupsRequest)\n- [1.7.1](/php/docs/reference/cloud-monitoring/1.7.1/V3.ListGroupsRequest)\n- [1.6.0](/php/docs/reference/cloud-monitoring/1.6.0/V3.ListGroupsRequest)\n- [1.5.1](/php/docs/reference/cloud-monitoring/1.5.1/V3.ListGroupsRequest)\n- [1.4.0](/php/docs/reference/cloud-monitoring/1.4.0/V3.ListGroupsRequest)\n- [1.3.2](/php/docs/reference/cloud-monitoring/1.3.2/V3.ListGroupsRequest)\n- [1.2.2](/php/docs/reference/cloud-monitoring/1.2.2/V3.ListGroupsRequest) \nReference documentation and code samples for the Stackdriver Monitoring V3 Client class ListGroupsRequest.\n\nThe `ListGroup` request.\n\nGenerated from protobuf message `google.monitoring.v3.ListGroupsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Monitoring \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The\n[project](https://cloud.google.com/monitoring/api/v3#project_name) whose\ngroups are to be listed. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\n\n### setName\n\nRequired. The\n[project](https://cloud.google.com/monitoring/api/v3#project_name) whose\ngroups are to be listed. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\n\n### getChildrenOfGroup\n\nA group name. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/groups/\\[GROUP_ID\\]\nReturns groups whose `parent_name` field contains the group\nname. If no groups have this parent, the results are empty.\n\n### hasChildrenOfGroup\n\n### setChildrenOfGroup\n\nA group name. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/groups/\\[GROUP_ID\\]\nReturns groups whose `parent_name` field contains the group\nname. If no groups have this parent, the results are empty.\n\n### getAncestorsOfGroup\n\nA group name. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/groups/\\[GROUP_ID\\]\nReturns groups that are ancestors of the specified group.\n\nThe groups are returned in order, starting with the immediate parent and\nending with the most distant ancestor. If the specified group has no\nimmediate parent, the results are empty.\n\n### hasAncestorsOfGroup\n\n### setAncestorsOfGroup\n\nA group name. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/groups/\\[GROUP_ID\\]\nReturns groups that are ancestors of the specified group.\n\nThe groups are returned in order, starting with the immediate parent and\nending with the most distant ancestor. If the specified group has no\nimmediate parent, the results are empty.\n\n### getDescendantsOfGroup\n\nA group name. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/groups/\\[GROUP_ID\\]\nReturns the descendants of the specified group. This is a superset of\nthe results returned by the `children_of_group` filter, and includes\nchildren-of-children, and so forth.\n\n### hasDescendantsOfGroup\n\n### setDescendantsOfGroup\n\nA group name. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]/groups/\\[GROUP_ID\\]\nReturns the descendants of the specified group. This is a superset of\nthe results returned by the `children_of_group` filter, and includes\nchildren-of-children, and so forth.\n\n### getPageSize\n\nA positive number that is the maximum number of results to return.\n\n### setPageSize\n\nA positive number that is the maximum number of results to return.\n\n### getPageToken\n\nIf this field is not empty then it must contain the `next_page_token` value\nreturned by a previous call to this method. Using this field causes the\nmethod to return additional results from the previous method call.\n\n### setPageToken\n\nIf this field is not empty then it must contain the `next_page_token` value\nreturned by a previous call to this method. Using this field causes the\nmethod to return additional results from the previous method call.\n\n### getFilter\n\n### static::build"]]
