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 | |
---|---|
Name | Description |
|
MetricsScopesClient const &
|
MetricsScopesClient(MetricsScopesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetricsScopesClient &&
|
MetricsScopesClient(std::shared_ptr< MetricsScopesConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< MetricsScopesConnection >
|
opts |
Options
|
Operators
operator=(MetricsScopesClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetricsScopesClient const &
|
Returns | |
---|---|
Type | Description |
MetricsScopesClient & |
operator=(MetricsScopesClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetricsScopesClient &&
|
Returns | |
---|---|
Type | Description |
MetricsScopesClient & |
Functions
GetMetricsScope(std::string const &, Options)
Returns a specific Metrics Scope
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
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 |
GetMetricsScope(google::monitoring::metricsscope::v1::GetMetricsScopeRequest const &, Options)
Returns a specific Metrics Scope
.
Parameters | |
---|---|
Name | Description |
request |
google::monitoring::metricsscope::v1::GetMetricsScopeRequest 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::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 |
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 | |
---|---|
Name | Description |
request |
google::monitoring::metricsscope::v1::ListMetricsScopesByMonitoredProjectRequest 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::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 |
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 | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the existing |
monitored_project |
google::monitoring::metricsscope::v1::MonitoredProject const &
Required. The initial |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::monitoring::metricsscope::v1::MonitoredProject > > |
A |
CreateMonitoredProject(NoAwaitTag, std::string const &, google::monitoring::metricsscope::v1::MonitoredProject const &, Options)
Adds a MonitoredProject
with the given project ID to the specified Metrics Scope
.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
monitored_project |
google::monitoring::metricsscope::v1::MonitoredProject const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateMonitoredProject(google::monitoring::metricsscope::v1::CreateMonitoredProjectRequest const &, Options)
Adds a MonitoredProject
with the given project ID to the specified Metrics Scope
.
Parameters | |
---|---|
Name | Description |
request |
google::monitoring::metricsscope::v1::CreateMonitoredProjectRequest 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 |
future< StatusOr< google::monitoring::metricsscope::v1::MonitoredProject > > |
A |
CreateMonitoredProject(NoAwaitTag, google::monitoring::metricsscope::v1::CreateMonitoredProjectRequest const &, Options)
Adds a MonitoredProject
with the given project ID to the specified Metrics Scope
.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::monitoring::metricsscope::v1::CreateMonitoredProjectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateMonitoredProject(google::longrunning::Operation const &, Options)
Adds a MonitoredProject
with the given project ID to the specified Metrics Scope
.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::monitoring::metricsscope::v1::MonitoredProject > > |
DeleteMonitoredProject(std::string const &, Options)
Deletes a MonitoredProject
from the specified Metrics Scope
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::monitoring::metricsscope::v1::OperationMetadata > > |
A |
DeleteMonitoredProject(NoAwaitTag, std::string const &, Options)
Deletes a MonitoredProject
from the specified Metrics Scope
.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteMonitoredProject(google::monitoring::metricsscope::v1::DeleteMonitoredProjectRequest const &, Options)
Deletes a MonitoredProject
from the specified Metrics Scope
.
Parameters | |
---|---|
Name | Description |
request |
google::monitoring::metricsscope::v1::DeleteMonitoredProjectRequest 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 |
future< StatusOr< google::monitoring::metricsscope::v1::OperationMetadata > > |
A |
DeleteMonitoredProject(NoAwaitTag, google::monitoring::metricsscope::v1::DeleteMonitoredProjectRequest const &, Options)
Deletes a MonitoredProject
from the specified Metrics Scope
.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::monitoring::metricsscope::v1::DeleteMonitoredProjectRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteMonitoredProject(google::longrunning::Operation const &, Options)
Deletes a MonitoredProject
from the specified Metrics Scope
.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::monitoring::metricsscope::v1::OperationMetadata > > |