Class DashboardsServiceGrpc.DashboardsServiceFutureStub (2.46.0)

public static final class DashboardsServiceGrpc.DashboardsServiceFutureStub extends AbstractFutureStub<DashboardsServiceGrpc.DashboardsServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > DashboardsServiceGrpc.DashboardsServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected DashboardsServiceGrpc.DashboardsServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DashboardsServiceGrpc.DashboardsServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDashboard(CreateDashboardRequest request)

public ListenableFuture<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
Name Description
request CreateDashboardRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Dashboard>

deleteDashboard(DeleteDashboardRequest request)

public ListenableFuture<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
Name Description
request DeleteDashboardRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getDashboard(GetDashboardRequest request)

public ListenableFuture<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
Name Description
request GetDashboardRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Dashboard>

listDashboards(ListDashboardsRequest request)

public ListenableFuture<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
Name Description
request ListDashboardsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDashboardsResponse>

updateDashboard(UpdateDashboardRequest request)

public ListenableFuture<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
Name Description
request UpdateDashboardRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Dashboard>