Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListGroupsRequest.
The ListGroup request.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#ancestors_of_group
defancestors_of_group()->::String
Returns
(::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.
Note: The following fields are mutually exclusive: ancestors_of_group, children_of_group, descendants_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
#ancestors_of_group=
defancestors_of_group=(value)->::String
Parameter
value (::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.
Note: The following fields are mutually exclusive: ancestors_of_group, children_of_group, descendants_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::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.
Note: The following fields are mutually exclusive: ancestors_of_group, children_of_group, descendants_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
#children_of_group
defchildren_of_group()->::String
Returns
(::String) — A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups whose parent_name field contains the group
name. If no groups have this parent, the results are empty.
Note: The following fields are mutually exclusive: children_of_group, ancestors_of_group, descendants_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
#children_of_group=
defchildren_of_group=(value)->::String
Parameter
value (::String) — A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups whose parent_name field contains the group
name. If no groups have this parent, the results are empty.
Note: The following fields are mutually exclusive: children_of_group, ancestors_of_group, descendants_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — A group name. The format is:
projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Returns groups whose parent_name field contains the group
name. If no groups have this parent, the results are empty.
Note: The following fields are mutually exclusive: children_of_group, ancestors_of_group, descendants_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
#descendants_of_group
defdescendants_of_group()->::String
Returns
(::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 the children_of_group filter, and includes
children-of-children, and so forth.
Note: The following fields are mutually exclusive: descendants_of_group, children_of_group, ancestors_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
#descendants_of_group=
defdescendants_of_group=(value)->::String
Parameter
value (::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 the children_of_group filter, and includes
children-of-children, and so forth.
Note: The following fields are mutually exclusive: descendants_of_group, children_of_group, ancestors_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::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 the children_of_group filter, and includes
children-of-children, and so forth.
Note: The following fields are mutually exclusive: descendants_of_group, children_of_group, ancestors_of_group. If a field in that set is populated, all other fields in the set will automatically be cleared.
#name
defname()->::String
Returns
(::String) —
Required. The
project whose
groups are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
#name=
defname=(value)->::String
Parameter
value (::String) —
Required. The
project whose
groups are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Returns
(::String) —
Required. The
project whose
groups are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
#page_size
defpage_size()->::Integer
Returns
(::Integer) — A positive number that is the maximum number of results to return.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — A positive number that is the maximum number of results to return.
Returns
(::Integer) — A positive number that is the maximum number of results to return.
#page_token
defpage_token()->::String
Returns
(::String) — If this field is not empty then it must contain the next_page_token value
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — If this field is not empty then it must contain the next_page_token value
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
Returns
(::String) — If this field is not empty then it must contain the next_page_token value
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
[[["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,["# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListGroupsRequest (v1.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.1 (latest)](/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.6.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.5.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.5.1/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.4.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.3.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.2.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.1.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.0.1/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.18.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.17.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.16.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.15.2](/ruby/docs/reference/google-cloud-monitoring-v3/0.15.2/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.14.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.13.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.12.1/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.11.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.10.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.9.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.8.0/Google-Cloud-Monitoring-V3-ListGroupsRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.7.1/Google-Cloud-Monitoring-V3-ListGroupsRequest) \nReference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListGroupsRequest.\n\nThe `ListGroup` request. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #ancestors_of_group\n\n def ancestors_of_group() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A group name. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns groups that are ancestors of the specified group.\n The groups are returned in order, starting with the immediate parent and\n ending with the most distant ancestor. If the specified group has no\n immediate parent, the results are empty.\n\n Note: The following fields are mutually exclusive: `ancestors_of_group`, `children_of_group`, `descendants_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #ancestors_of_group=\n\n def ancestors_of_group=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A group name. The format is:\n\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns groups that are ancestors of the specified group.\n The groups are returned in order, starting with the immediate parent and\n ending with the most distant ancestor. If the specified group has no\n immediate parent, the results are empty.\n\nNote: The following fields are mutually exclusive: `ancestors_of_group`, `children_of_group`, `descendants_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A group name. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns groups that are ancestors of the specified group.\n The groups are returned in order, starting with the immediate parent and\n ending with the most distant ancestor. If the specified group has no\n immediate parent, the results are empty.\n\n Note: The following fields are mutually exclusive: `ancestors_of_group`, `children_of_group`, `descendants_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #children_of_group\n\n def children_of_group() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A group name. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns groups whose `parent_name` field contains the group\n name. If no groups have this parent, the results are empty.\n\n Note: The following fields are mutually exclusive: `children_of_group`, `ancestors_of_group`, `descendants_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #children_of_group=\n\n def children_of_group=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A group name. The format is:\n\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns groups whose `parent_name` field contains the group\n name. If no groups have this parent, the results are empty.\n\nNote: The following fields are mutually exclusive: `children_of_group`, `ancestors_of_group`, `descendants_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A group name. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns groups whose `parent_name` field contains the group\n name. If no groups have this parent, the results are empty.\n\n Note: The following fields are mutually exclusive: `children_of_group`, `ancestors_of_group`, `descendants_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #descendants_of_group\n\n def descendants_of_group() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A group name. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns the descendants of the specified group. This is a superset of\n the results returned by the `children_of_group` filter, and includes\n children-of-children, and so forth.\n\n Note: The following fields are mutually exclusive: `descendants_of_group`, `children_of_group`, `ancestors_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #descendants_of_group=\n\n def descendants_of_group=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A group name. The format is:\n\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns the descendants of the specified group. This is a superset of\n the results returned by the `children_of_group` filter, and includes\n children-of-children, and so forth.\n\nNote: The following fields are mutually exclusive: `descendants_of_group`, `children_of_group`, `ancestors_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A group name. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]\n\n Returns the descendants of the specified group. This is a superset of\n the results returned by the `children_of_group` filter, and includes\n children-of-children, and so forth.\n\n Note: The following fields are mutually exclusive: `descendants_of_group`, `children_of_group`, `ancestors_of_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The\n [project](https://cloud.google.com/monitoring/api/v3#project_name) whose\n groups are to be listed. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Required. The\n [project](https://cloud.google.com/monitoring/api/v3#project_name) whose\n groups are to be listed. The format is: \n\n projects/[PROJECT_ID_OR_NUMBER]\n\n**Returns**\n\n- (::String) --- Required. The\n [project](https://cloud.google.com/monitoring/api/v3#project_name) whose\n groups are to be listed. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- A positive number that is the maximum number of results to return.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- A positive number that is the maximum number of results to return. \n**Returns**\n\n- (::Integer) --- A positive number that is the maximum number of results to return.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- If this field is not empty then it must contain the `next_page_token` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- If this field is not empty then it must contain the `next_page_token` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. \n**Returns**\n\n- (::String) --- If this field is not empty then it must contain the `next_page_token` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call."]]
