# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListGroupsRequest (v1.10.0)

1.10.0 (latest) 1.9.0 1.8.0 1.7.1 1.6.1 1.5.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.0 0.16.0 0.15.2 0.14.0 0.13.0 0.12.1 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 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

    def ancestors_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=

    def ancestors_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

    def children_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=

    def children_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

    def descendants_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=

    def descendants_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

    def name() -> ::String

**Returns**

- (::String) --- Required. The
  [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
  groups are to be listed. The format is:

      projects/[PROJECT_ID_OR_NUMBER]

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) ---

  Required. The
  [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
  groups are to be listed. The format is:

      projects/[PROJECT_ID_OR_NUMBER]

**Returns**

- (::String) --- Required. The
  [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
  groups are to be listed. The format is:

      projects/[PROJECT_ID_OR_NUMBER]

### #page_size

    def page_size() -> ::Integer

**Returns**

- (::Integer) --- A positive number that is the maximum number of results to return.

### #page_size=

    def page_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

    def page_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=

    def page_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.