Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListGroupsRequest (v0.12.0)

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.

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

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.

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

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

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.

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

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

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.

#name

def name() -> ::String
Returns
  • (::String) —

    Required. The project 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 whose groups are to be listed. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
Returns
  • (::String) —

    Required. The project 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.