Interface ListGroupsRequestOrBuilder (3.22.0)

Version 3.22.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.6
• 3.3.6
• 3.2.10

public interface ListGroupsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAncestorsOfGroup()

public abstract String 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.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The ancestorsOfGroup.

getAncestorsOfGroupBytes()

public abstract ByteString getAncestorsOfGroupBytes()

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.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for ancestorsOfGroup.

getChildrenOfGroup()

public abstract String getChildrenOfGroup()

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.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The childrenOfGroup.

getChildrenOfGroupBytes()

public abstract ByteString getChildrenOfGroupBytes()

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.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for childrenOfGroup.

getDescendantsOfGroup()

public abstract String 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 the children_of_group filter, and includes children-of-children, and so forth.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The descendantsOfGroup.

getDescendantsOfGroupBytes()

public abstract ByteString getDescendantsOfGroupBytes()

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.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for descendantsOfGroup.

getFilterCase()

public abstract ListGroupsRequest.FilterCase getFilterCase()

Returns
Type	Description
ListGroupsRequest.FilterCase

getName()

public abstract String getName()

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The project whose groups are to be listed. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

string name = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for name.

getPageSize()

public abstract int getPageSize()

A positive number that is the maximum number of results to return.

int32 page_size = 5;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 6;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 6;

Returns
Type	Description
ByteString	The bytes for pageToken.

hasAncestorsOfGroup()

public abstract boolean hasAncestorsOfGroup()

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.

string ancestors_of_group = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the ancestorsOfGroup field is set.

hasChildrenOfGroup()

public abstract boolean hasChildrenOfGroup()

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.

string children_of_group = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the childrenOfGroup field is set.

hasDescendantsOfGroup()

public abstract boolean hasDescendantsOfGroup()

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.

string descendants_of_group = 4 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the descendantsOfGroup field is set.