Class ServiceMonitoringServiceClient (2.23.0-rc)

Version latest

• 2.25.0-rc (latest)
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services.

These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

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

ServiceMonitoringServiceClient(ServiceMonitoringServiceClient const &)

Copy and move support

Parameter
Name	Description
	ServiceMonitoringServiceClient const &

ServiceMonitoringServiceClient(ServiceMonitoringServiceClient &&)

Copy and move support

Parameter
Name	Description
	ServiceMonitoringServiceClient &&

ServiceMonitoringServiceClient(std::shared_ptr< ServiceMonitoringServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ServiceMonitoringServiceConnection >
opts	Options

Operators

operator=(ServiceMonitoringServiceClient const &)

Copy and move support

Parameter
Name	Description
	ServiceMonitoringServiceClient const &

Returns
Type	Description
ServiceMonitoringServiceClient &

operator=(ServiceMonitoringServiceClient &&)

Copy and move support

Parameter
Name	Description
	ServiceMonitoringServiceClient &&

Returns
Type	Description
ServiceMonitoringServiceClient &

Functions

CreateService(std::string const &, google::monitoring::v3::Service const &, Options)

Create a Service.

Parameters
Name	Description
parent	std::string const & Required. Resource name of the parent workspace. The format is: projects/[PROJECT_ID_OR_NUMBER]
service	google::monitoring::v3::Service const & Required. The Service to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateService(google::monitoring::v3::CreateServiceRequest const &, Options)

Create a Service.

Parameters
Name	Description
request	google::monitoring::v3::CreateServiceRequest 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.CreateServiceRequest. 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::Service >	the result of the RPC. The response message type (google.monitoring.v3.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetService(std::string const &, Options)

Get the named Service.

Parameters
Name	Description
name	std::string const & Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetService(google::monitoring::v3::GetServiceRequest const &, Options)

Get the named Service.

Parameters
Name	Description
request	google::monitoring::v3::GetServiceRequest 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.GetServiceRequest. 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::Service >	the result of the RPC. The response message type (google.monitoring.v3.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListServices(std::string const &, Options)

List Services for this workspace.

Parameters
Name	Description
parent	std::string const & Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_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::Service >	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.Service, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListServices(google::monitoring::v3::ListServicesRequest, Options)

List Services for this workspace.

Parameters
Name	Description
request	google::monitoring::v3::ListServicesRequest 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.ListServicesRequest. 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::Service >	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.Service, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateService(google::monitoring::v3::Service const &, Options)

Update this Service.

Parameters
Name	Description
service	google::monitoring::v3::Service const & Required. The Service to draw updates from. The given name specifies the resource to update.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateService(google::monitoring::v3::UpdateServiceRequest const &, Options)

Update this Service.

Parameters
Name	Description
request	google::monitoring::v3::UpdateServiceRequest 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.UpdateServiceRequest. 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::Service >	the result of the RPC. The response message type (google.monitoring.v3.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteService(std::string const &, Options)

Soft delete this Service.

Parameters
Name	Description
name	std::string const & Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_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.

DeleteService(google::monitoring::v3::DeleteServiceRequest const &, Options)

Soft delete this Service.

Parameters
Name	Description
request	google::monitoring::v3::DeleteServiceRequest 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.DeleteServiceRequest. 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.

CreateServiceLevelObjective(std::string const &, google::monitoring::v3::ServiceLevelObjective const &, Options)

Create a ServiceLevelObjective for the given Service.

Parameters
Name	Description
parent	std::string const & Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
service_level_objective	google::monitoring::v3::ServiceLevelObjective const & Required. The ServiceLevelObjective to create. The provided name will be respected if no ServiceLevelObjective exists with this name.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateServiceLevelObjective(google::monitoring::v3::CreateServiceLevelObjectiveRequest const &, Options)

Create a ServiceLevelObjective for the given Service.

Parameters
Name	Description
request	google::monitoring::v3::CreateServiceLevelObjectiveRequest 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.CreateServiceLevelObjectiveRequest. 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::ServiceLevelObjective >	the result of the RPC. The response message type (google.monitoring.v3.ServiceLevelObjective) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetServiceLevelObjective(std::string const &, Options)

Get a ServiceLevelObjective by name.

Parameters
Name	Description
name	std::string const & Required. Resource name of the ServiceLevelObjective to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetServiceLevelObjective(google::monitoring::v3::GetServiceLevelObjectiveRequest const &, Options)

Get a ServiceLevelObjective by name.

Parameters
Name	Description
request	google::monitoring::v3::GetServiceLevelObjectiveRequest 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.GetServiceLevelObjectiveRequest. 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::ServiceLevelObjective >	the result of the RPC. The response message type (google.monitoring.v3.ServiceLevelObjective) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListServiceLevelObjectives(std::string const &, Options)

List the ServiceLevelObjectives for the given Service.

Parameters
Name	Description
parent	std::string const & Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::monitoring::v3::ServiceLevelObjective >	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.ServiceLevelObjective, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListServiceLevelObjectives(google::monitoring::v3::ListServiceLevelObjectivesRequest, Options)

List the ServiceLevelObjectives for the given Service.

Parameters
Name	Description
request	google::monitoring::v3::ListServiceLevelObjectivesRequest 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.ListServiceLevelObjectivesRequest. 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::ServiceLevelObjective >	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.ServiceLevelObjective, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateServiceLevelObjective(google::monitoring::v3::ServiceLevelObjective const &, Options)

Update the given ServiceLevelObjective.

Parameters
Name	Description
service_level_objective	google::monitoring::v3::ServiceLevelObjective const & Required. The ServiceLevelObjective to draw updates from. The given name specifies the resource to update.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateServiceLevelObjective(google::monitoring::v3::UpdateServiceLevelObjectiveRequest const &, Options)

Update the given ServiceLevelObjective.

Parameters
Name	Description
request	google::monitoring::v3::UpdateServiceLevelObjectiveRequest 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.UpdateServiceLevelObjectiveRequest. 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::ServiceLevelObjective >	the result of the RPC. The response message type (google.monitoring.v3.ServiceLevelObjective) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteServiceLevelObjective(std::string const &, Options)

Delete the given ServiceLevelObjective.

Parameters
Name	Description
name	std::string const & Required. Resource name of the ServiceLevelObjective to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
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.

DeleteServiceLevelObjective(google::monitoring::v3::DeleteServiceLevelObjectiveRequest const &, Options)

Delete the given ServiceLevelObjective.

Parameters
Name	Description
request	google::monitoring::v3::DeleteServiceLevelObjectiveRequest 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.DeleteServiceLevelObjectiveRequest. 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.