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: |
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 |
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 |
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 |
GetGroup(std::string const &, Options)
Gets a single group.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The group to retrieve. The format is: |
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 |
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 |
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 |
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: |
group |
google::monitoring::v3::Group const &
Required. A group definition. It is an error to define the |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
DeleteGroup(std::string const &, Options)
Deletes an existing group.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The group to delete. The format is: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status | a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status | a |
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: |
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 |
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 |
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 |