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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/group_service.rb

Overview

The ListGroup request.

Instance Attribute Summary collapse

Instance Attribute Details

#ancestors_of_group ⇒ ::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.



66
67
68
69
 
# File 'proto_docs/google/monitoring/v3/group_service.rb', line 66

class ListGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#children_of_group ⇒ ::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.



66
67
68
69
 
# File 'proto_docs/google/monitoring/v3/group_service.rb', line 66

class ListGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#descendants_of_group ⇒ ::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.



66
67
68
69
 
# File 'proto_docs/google/monitoring/v3/group_service.rb', line 66

class ListGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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



66
67
68
69
 
# File 'proto_docs/google/monitoring/v3/group_service.rb', line 66

class ListGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.



66
67
68
69
 
# File 'proto_docs/google/monitoring/v3/group_service.rb', line 66

class ListGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::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.



66
67
68
69
 
# File 'proto_docs/google/monitoring/v3/group_service.rb', line 66

class ListGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end