Interface DashboardsServiceGrpc.AsyncService (2.56.0)

public static interface DashboardsServiceGrpc.AsyncService

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

Methods

createDashboard(CreateDashboardRequest request, StreamObserver<Dashboard> responseObserver)

public default void createDashboard(CreateDashboardRequest request, StreamObserver<Dashboard> responseObserver)

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 CreateDashboardRequest
responseObserver io.grpc.stub.StreamObserver<Dashboard>

deleteDashboard(DeleteDashboardRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDashboard(DeleteDashboardRequest request, StreamObserver<Empty> responseObserver)

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 DeleteDashboardRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getDashboard(GetDashboardRequest request, StreamObserver<Dashboard> responseObserver)

public default void getDashboard(GetDashboardRequest request, StreamObserver<Dashboard> responseObserver)

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 GetDashboardRequest
responseObserver io.grpc.stub.StreamObserver<Dashboard>

listDashboards(ListDashboardsRequest request, StreamObserver<ListDashboardsResponse> responseObserver)

public default void listDashboards(ListDashboardsRequest request, StreamObserver<ListDashboardsResponse> responseObserver)

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 ListDashboardsRequest
responseObserver io.grpc.stub.StreamObserver<ListDashboardsResponse>

updateDashboard(UpdateDashboardRequest request, StreamObserver<Dashboard> responseObserver)

public default void updateDashboard(UpdateDashboardRequest request, StreamObserver<Dashboard> responseObserver)

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 UpdateDashboardRequest
responseObserver io.grpc.stub.StreamObserver<Dashboard>