class ListGroupsRequest extends Message

The ListGroup request.

Protobuf type Google\Monitoring\V3\ListGroupsRequest

Properties

protected $filter

Methods

__construct()

No description

string
getName()

The project whose groups are to be listed. The format is "projects/{project_id_or_number}".

setName(string $var)

The project whose groups are to be listed. The format is "projects/{project_id_or_number}".

string
getChildrenOfGroup()

A group name: "projects/{project_id_or_number}/groups/{group_id}".

setChildrenOfGroup(string $var)

A group name: "projects/{project_id_or_number}/groups/{group_id}".

string
getAncestorsOfGroup()

A group name: "projects/{project_id_or_number}/groups/{group_id}".

setAncestorsOfGroup(string $var)

A group name: "projects/{project_id_or_number}/groups/{group_id}".

string
getDescendantsOfGroup()

A group name: "projects/{project_id_or_number}/groups/{group_id}".

setDescendantsOfGroup(string $var)

A group name: "projects/{project_id_or_number}/groups/{group_id}".

int
getPageSize()

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

setPageSize(int $var)

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

string
getPageToken()

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

setPageToken(string $var)

If this field is not empty then it must contain the nextPageToken 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
getFilter()

No description

Details

at line 41
__construct()

at line 53
string getName()

The project whose groups are to be listed. The format is "projects/{project_id_or_number}".

Generated from protobuf field string name = 7;

Return Value

string

at line 65
setName(string $var)

The project whose groups are to be listed. The format is "projects/{project_id_or_number}".

Generated from protobuf field string name = 7;

Parameters

string $var

at line 79
string getChildrenOfGroup()

A group name: "projects/{project_id_or_number}/groups/{group_id}".

Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.

Generated from protobuf field string children_of_group = 2;

Return Value

string

at line 92
setChildrenOfGroup(string $var)

A group name: "projects/{project_id_or_number}/groups/{group_id}".

Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.

Generated from protobuf field string children_of_group = 2;

Parameters

string $var

at line 108
string getAncestorsOfGroup()

A group name: "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.

Generated from protobuf field string ancestors_of_group = 3;

Return Value

string

at line 123
setAncestorsOfGroup(string $var)

A group name: "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.

Generated from protobuf field string ancestors_of_group = 3;

Parameters

string $var

at line 138
string getDescendantsOfGroup()

A group name: "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 childrenOfGroup filter, and includes children-of-children, and so forth.

Generated from protobuf field string descendants_of_group = 4;

Return Value

string

at line 152
setDescendantsOfGroup(string $var)

A group name: "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 childrenOfGroup filter, and includes children-of-children, and so forth.

Generated from protobuf field string descendants_of_group = 4;

Parameters

string $var

at line 164
int getPageSize()

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

Generated from protobuf field int32 page_size = 5;

Return Value

int

at line 175
setPageSize(int $var)

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

Generated from protobuf field int32 page_size = 5;

Parameters

int $var

at line 189
string getPageToken()

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Generated from protobuf field string page_token = 6;

Return Value

string

at line 202
setPageToken(string $var)

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Generated from protobuf field string page_token = 6;

Parameters

string $var

at line 211
string getFilter()

Return Value

string