Class DashboardsServiceClient (2.21.0)

Manages Stackdriver dashboards.

A dashboard is an arrangement of data display widgets in a specific layout.

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

DashboardsServiceClient(DashboardsServiceClient const &)

Copy and move support

Parameter
NameDescription
DashboardsServiceClient const &

DashboardsServiceClient(DashboardsServiceClient &&)

Copy and move support

Parameter
NameDescription
DashboardsServiceClient &&

DashboardsServiceClient(std::shared_ptr< DashboardsServiceConnection >, Options)

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

Operators

operator=(DashboardsServiceClient const &)

Copy and move support

Parameter
NameDescription
DashboardsServiceClient const &
Returns
TypeDescription
DashboardsServiceClient &

operator=(DashboardsServiceClient &&)

Copy and move support

Parameter
NameDescription
DashboardsServiceClient &&
Returns
TypeDescription
DashboardsServiceClient &

Functions

CreateDashboard(google::monitoring::dashboard::v1::CreateDashboardRequest const &, Options)

Creates a new custom dashboard.

For examples on how you can use this API to create dashboards, see Managing dashboards by API. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.

Parameters
NameDescription
request google::monitoring::dashboard::v1::CreateDashboardRequest 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.dashboard.v1.CreateDashboardRequest. 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::dashboard::v1::Dashboard >

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

ListDashboards(google::monitoring::dashboard::v1::ListDashboardsRequest, Options)

Lists the existing dashboards.

This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Cloud Identity and Access Management.

Parameters
NameDescription
request google::monitoring::dashboard::v1::ListDashboardsRequest

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 g