Class GroupServiceClient (2.23.0)

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)