Class DashboardsServiceGrpc.DashboardsServiceBlockingStub (2.23.0)

public static final class DashboardsServiceGrpc.DashboardsServiceBlockingStub extends AbstractBlockingStub<DashboardsServiceGrpc.DashboardsServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service DashboardsService.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DashboardsServiceGrpc.DashboardsServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected DashboardsServiceGrpc.DashboardsServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DashboardsServiceGrpc.DashboardsServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDashboard(CreateDashboardRequest request)

public Dashboard createDashboard(CreateDashboardRequest request)

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.

Parameter
NameDescription
requestCreateDashboardRequest
Returns
TypeDescription
Dashboard

deleteDashboard(DeleteDashboardRequest request)

public Empty deleteDashboard(DeleteDashboardRequest request)

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.

Parameter
NameDescription
requestDeleteDashboardRequest
Returns
TypeDescription
Empty

getDashboard(GetDashboardRequest request)

public Dashboard getDashboard(GetDashboardRequest request)

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.

Parameter
NameDescription
requestGetDashboardRequest
Returns
TypeDescription
Dashboard

listDashboards(ListDashboardsRequest request)

public ListDashboardsResponse listDashboards(ListDashboardsRequest request)

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.

Parameter
NameDescription
requestListDashboardsRequest
Returns
TypeDescription
ListDashboardsResponse

updateDashboard(UpdateDashboardRequest request)

public Dashboard updateDashboard(UpdateDashboardRequest request)

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.

Parameter
NameDescription
requestUpdateDashboardRequest
Returns
TypeDescription
Dashboard