Class ListGroupsRequest (2.15.1)

ListGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The ListGroup request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
Required. The project __ whose groups are to be listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER]
children_of_group str
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. This field is a member of oneof_ filter.
ancestors_of_group str
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. This field is a member of oneof_ filter.
descendants_of_group str
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. This field is a member of oneof_ filter.
page_size int
A positive number that is the maximum number of results to return.
page_token str
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.