Class MetricsScopesClient (2.12.0)

Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.

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

MetricsScopesClient(MetricsScopesClient const &)

Copy and move support

Parameter
NameDescription
MetricsScopesClient const &

MetricsScopesClient(MetricsScopesClient &&)

Copy and move support

Parameter
NameDescription
MetricsScopesClient &&

MetricsScopesClient(std::shared_ptr< MetricsScopesConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< MetricsScopesConnection >
opts Options

Operators

operator=(MetricsScopesClient const &)

Copy and move support

Parameter
NameDescription
MetricsScopesClient const &
Returns
TypeDescription
MetricsScopesClient &

operator=(MetricsScopesClient &&)

Copy and move support

Parameter
NameDescription
MetricsScopesClient &&
Returns
TypeDescription
MetricsScopesClient &

Functions

GetMetricsScope(std::string const &, Options)

Returns a specific Metrics Scope.

Parameters
NameDescription
name std::string const &

Required. The resource name of the Metrics Scope. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::monitoring::metricsscope::v1::MetricsScope >

the result of the RPC. The response message type (google.monitoring.metricsscope.v1.MetricsScope) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMetricsScope(google::monitoring::metricsscope::v1::GetMetricsScopeRequest const &, Options)

Returns a specific Metrics Scope.

Parameters
NameDescription
request google::monitoring::metricsscope::v1::GetMetricsScopeRequest 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.metricsscope.v1.GetMetricsScopeRequest. 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
TypeDescription
StatusOr< google::monitoring::metricsscope::v1::MetricsScope >

the result of the RPC. The response message type (google.monitoring.metricsscope.v1.MetricsScope) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMetricsScopesByMonitoredProject(google::monitoring::metricsscope::v1::ListMetricsScopesByMonitoredProjectRequest const &, Options)

Returns a list of every Metrics Scope that a specific MonitoredProject has been added to.

The metrics scope representing the specified monitored project will always be the first entry in the response.

Parameters
NameDescription
request google::monitoring::metricsscope::v1::ListMetricsScopesByMonitoredProjectRequest 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.metricsscope.v1.ListMetricsScopesByMonitoredProjectRequest. 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
TypeDescription
StatusOr< google::monitoring::metricsscope::v1::ListMetricsScopesByMonitoredProjectResponse >

the result of the RPC. The response message type (google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateMonitoredProject(std::string const &, google::monitoring::metricsscope::v1::MonitoredProject const &, Options)

Adds a MonitoredProject with the given project ID to the specified Metrics Scope.

Parameters
NameDescription
parent std::string const &

Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}

monitored_project google::monitoring::metricsscope::v1::MonitoredProject const &

Required. The initial MonitoredProject configuration. Specify only the monitored_project.name field. All other fields are ignored. The monitored_project.name must be in the format: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::monitoring::metricsscope::v1::MonitoredProject > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.monitoring.metricsscope.v1.MonitoredProject proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMonitoredProject(google::monitoring::metricsscope::v1::CreateMonitoredProjectRequest const &, Options)

Adds a MonitoredProject with the given project ID to the specified Metrics Scope.

Parameters
NameDescription
request google::monitoring::metricsscope::v1::CreateMonitoredProjectRequest 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.metricsscope.v1.CreateMonitoredProjectRequest. 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
TypeDescription
future< StatusOr< google::monitoring::metricsscope::v1::MonitoredProject > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.monitoring.metricsscope.v1.MonitoredProject proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteMonitoredProject(std::string const &, Options)

Deletes a MonitoredProject from the specified Metrics Scope.

Parameters
NameDescription
name std::string const &

Required. The resource name of the MonitoredProject. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}
Authorization requires the following Google IAM permissions on both the Metrics Scope and on the MonitoredProject: monitoring.metricsScopes.link

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::monitoring::metricsscope::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.monitoring.metricsscope.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteMonitoredProject(google::monitoring::metricsscope::v1::DeleteMonitoredProjectRequest const &, Options)

Deletes a MonitoredProject from the specified Metrics Scope.

Parameters
NameDescription
request google::monitoring::metricsscope::v1::DeleteMonitoredProjectRequest 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.metricsscope.v1.DeleteMonitoredProjectRequest. 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
TypeDescription
future< StatusOr< google::monitoring::metricsscope::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.monitoring.metricsscope.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.