Class GroupServiceClient (2.23.0-rc)

The Group API lets you inspect and manage your groups.

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

GroupServiceClient(GroupServiceClient const &)

Copy and move support

Parameter
Name	Description
	`GroupServiceClient const &`

GroupServiceClient(GroupServiceClient &&)

Copy and move support

Parameter
Name	Description
	`GroupServiceClient &&`

GroupServiceClient(std::shared_ptr< GroupServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< GroupServiceConnection >`
`opts`	`Options`

Operators

operator=(GroupServiceClient const &)

Copy and move support

Parameter
Name	Description
	`GroupServiceClient const &`

Returns
Type	Description
`GroupServiceClient &`

operator=(GroupServiceClient &&)

Copy and move support

Parameter
Name	Description
	`GroupServiceClient &&`

Returns
Type	Description
`GroupServiceClient &`

Functions

ListGroups(std::string const &, Options)

Lists the existing groups.

Parameters
Name	Description
`name`	`std::string const &` Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::monitoring::v3::Group >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.monitoring.v3.Group, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGroups(google::monitoring::v3::ListGroupsRequest, Options)

Lists the existing groups.

Parameters
Name	Description
`request`	`google::monitoring::v3::ListGroupsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.monitoring.v3.ListGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::monitoring::v3::Group >

GetGroup(std::string const &, Options)

Gets a single group.

Parameters
Name	Description
`name`	`std::string const &` Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::monitoring::v3::Group >`	the result of the RPC. The response message type (google.monitoring.v3.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetGroup(google::monitoring::v3::GetGroupRequest const &, Options)

Gets a single group.

Parameters
Name	Description
`request`	`google::monitoring::v3::GetGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.monitoring.v3.GetGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::monitoring::v3::Group >`	the result of the RPC. The response message type (google.monitoring.v3.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateGroup(std::string const &, google::monitoring::v3::Group const &, Options)

Creates a new group.

Parameters
Name	Description
`name`	`std::string const &` Required. The project in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER]
`group`	`google::monitoring::v3::Group const &` Required. A group definition. It is an error to define the `name` field because the system assigns the name.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::monitoring::v3::Group >`	the result of the RPC. The response message type (google.monitoring.v3.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateGroup(google::monitoring::v3::CreateGroupRequest const &, Options)

Creates a new group.

Parameters
Name	Description
`request`	`google::monitoring::v3::CreateGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.monitoring.v3.CreateGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::monitoring::v3::Group >`	the result of the RPC. The response message type (google.monitoring.v3.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateGroup(google::monitoring::v3::Group const &, Options)

Updates an existing group.

You can change any group attributes except name.

Parameters
Name	Description
`group`	`google::monitoring::v3::Group const &` Required. The new definition of the group. All fields of the existing group, excepting `name`, are replaced with the corresponding fields of this group.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::monitoring::v3::Group >`	the result of the RPC. The response message type (google.monitoring.v3.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateGroup(google::monitoring::v3::UpdateGroupRequest const &, Options)

Updates an existing group.

You can change any group attributes except name.

Parameters
Name	Description
`request`	`google::monitoring::v3::UpdateGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.monitoring.v3.UpdateGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::monitoring::v3::Group >`	the result of the RPC. The response message type (google.monitoring.v3.Group) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteGroup(std::string const &, Options)

Deletes an existing group.

Parameters
Name	Description
`name`	`std::string const &` Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteGroup(google::monitoring::v3::DeleteGroupRequest const &, Options)

Deletes an existing group.

Parameters
Name	Description
`request`	`google::monitoring::v3::DeleteGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.monitoring.v3.DeleteGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListGroupMembers(std::string const &, Options)

Lists the monitored resources that are members of a group.

Parameters
Name	Description
`name`	`std::string const &` Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::api::MonitoredResource >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.api.MonitoredResource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGroupMembers(google::monitoring::v3::ListGroupMembersRequest, Options)

Lists the monitored resources that are members of a group.

Parameters
Name	Description
`request`	`google::monitoring::v3::ListGroupMembersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.monitoring.v3.ListGroupMembersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::api::MonitoredResource >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.api.MonitoredResource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.