Class: Google::Monitoring::V3::ListGroupsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb

Overview

The +ListGroup+ request.

Instance Attribute Summary collapse

Instance Attribute Details

#ancestors_of_group ⇒ String

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.

Returns:

  • (String) —

    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.



49
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb', line 49

class ListGroupsRequest; end

#children_of_group ⇒ String

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.

Returns:

  • (String) —

    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.



49
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb', line 49

class ListGroupsRequest; end

#descendants_of_group ⇒ String

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.

Returns:

  • (String) —

    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.



49
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb', line 49

class ListGroupsRequest; end

#name ⇒ String

Returns The project whose groups are to be listed. The format is +"projects/project_id_or_number"+.

Returns:

  • (String) —

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



49
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb', line 49

class ListGroupsRequest; end

#page_size ⇒ Integer

Returns 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.



49
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb', line 49

class ListGroupsRequest; end

#page_token ⇒ String

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.

Returns:

  • (String) —

    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.



49
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb', line 49

class ListGroupsRequest; end