Class DashboardsServiceClient (2.17.0)

Version 2.17.0

• 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

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
Name	Description
	DashboardsServiceClient const &

DashboardsServiceClient(DashboardsServiceClient &&)

Copy and move support

Parameter
Name	Description
	DashboardsServiceClient &&

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

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

Operators

operator=(DashboardsServiceClient const &)

Copy and move support

Parameter
Name	Description
	DashboardsServiceClient const &

Returns
Type	Description
DashboardsServiceClient &

operator=(DashboardsServiceClient &&)

Copy and move support

Parameter
Name	Description
	DashboardsServiceClient &&

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

GetDashboard(google::monitoring::dashboard::v1::GetDashboardRequest const &, Options)

Fetches a specific dashboard.

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

Parameters
Name	Description
request	google::monitoring::dashboard::v1::GetDashboardRequest 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.GetDashboardRequest. 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::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.

DeleteDashboard(google::monitoring::dashboard::v1::DeleteDashboardRequest const &, Options)

Deletes an existing custom dashboard.

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

Parameters
Name	Description
request	google::monitoring::dashboard::v1::DeleteDashboardRequest 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.DeleteDashboardRequest. 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.

UpdateDashboard(google::monitoring::dashboard::v1::UpdateDashboardRequest const &, Options)

Replaces an existing custom dashboard with a new definition.

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

Parameters
Name	Description
request	google::monitoring::dashboard::v1::UpdateDashboardRequest 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.UpdateDashboardRequest. 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::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.