Class protos.google.monitoring.dashboard.v1.DashboardsService

Represents a DashboardsService

Inheritance

$protobuf.rpc.Service > protos.google.monitoring.dashboard.v1.DashboardsService

Package

@google-cloud/monitoring-dashboards

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DashboardsService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DashboardsService;

Creates new DashboardsService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
DashboardsService

RPC service. Useful where requests and/or responses are streamed.

createDashboard(request, callback)

public createDashboard(request: google.monitoring.dashboard.v1.ICreateDashboardRequest, callback: google.monitoring.dashboard.v1.DashboardsService.CreateDashboardCallback): void;

Calls CreateDashboard.

Parameters
NameDescription
request google.monitoring.dashboard.v1.ICreateDashboardRequest

CreateDashboardRequest message or plain object

callback google.monitoring.dashboard.v1.DashboardsService.CreateDashboardCallback

Node-style callback called with the error, if any, and Dashboard

Returns
TypeDescription
void

createDashboard(request)

public createDashboard(request: google.monitoring.dashboard.v1.ICreateDashboardRequest): Promise<google.monitoring.dashboard.v1.Dashboard>;

Calls CreateDashboard.

Parameter
NameDescription
request google.monitoring.dashboard.v1.ICreateDashboardRequest

CreateDashboardRequest message or plain object

Returns
TypeDescription
Promise<google.monitoring.dashboard.v1.Dashboard>

Promise

deleteDashboard(request, callback)

public deleteDashboard(request: google.monitoring.dashboard.v1.IDeleteDashboardRequest, callback: google.monitoring.dashboard.v1.DashboardsService.DeleteDashboardCallback): void;

Calls DeleteDashboard.

Parameters
NameDescription
request google.monitoring.dashboard.v1.IDeleteDashboardRequest

DeleteDashboardRequest message or plain object

callback google.monitoring.dashboard.v1.DashboardsService.DeleteDashboardCallback

Node-style callback called with the error, if any, and Empty

Returns
TypeDescription
void

deleteDashboard(request)

public deleteDashboard(request: google.monitoring.dashboard.v1.IDeleteDashboardRequest): Promise<google.protobuf.Empty>;

Calls DeleteDashboard.

Parameter
NameDescription
request google.monitoring.dashboard.v1.IDeleteDashboardRequest

DeleteDashboardRequest message or plain object

Returns
TypeDescription
Promise<google.protobuf.Empty>

Promise

getDashboard(request, callback)

public getDashboard(request: google.monitoring.dashboard.v1.IGetDashboardRequest, callback: google.monitoring.dashboard.v1.DashboardsService.GetDashboardCallback): void;

Calls GetDashboard.

Parameters
NameDescription
request google.monitoring.dashboard.v1.IGetDashboardRequest

GetDashboardRequest message or plain object

callback google.monitoring.dashboard.v1.DashboardsService.GetDashboardCallback

Node-style callback called with the error, if any, and Dashboard

Returns
TypeDescription
void

getDashboard(request)

public getDashboard(request: google.monitoring.dashboard.v1.IGetDashboardRequest): Promise<google.monitoring.dashboard.v1.Dashboard>;

Calls GetDashboard.

Parameter
NameDescription
request google.monitoring.dashboard.v1.IGetDashboardRequest

GetDashboardRequest message or plain object

Returns
TypeDescription
Promise<google.monitoring.dashboard.v1.Dashboard>

Promise

listDashboards(request, callback)

public listDashboards(request: google.monitoring.dashboard.v1.IListDashboardsRequest, callback: google.monitoring.dashboard.v1.DashboardsService.ListDashboardsCallback): void;

Calls ListDashboards.

Parameters
NameDescription
request IListDashboardsRequest

ListDashboardsRequest message or plain object

callback google.monitoring.dashboard.v1.DashboardsService.ListDashboardsCallback

Node-style callback called with the error, if any, and ListDashboardsResponse

Returns
TypeDescription
void

listDashboards(request)

public listDashboards(request: google.monitoring.dashboard.v1.IListDashboardsRequest): Promise<google.monitoring.dashboard.v1.ListDashboardsResponse>;

Calls ListDashboards.

Parameter
NameDescription
request IListDashboardsRequest

ListDashboardsRequest message or plain object

Returns
TypeDescription
Promise<google.monitoring.dashboard.v1.ListDashboardsResponse>

Promise

updateDashboard(request, callback)

public updateDashboard(request: google.monitoring.dashboard.v1.IUpdateDashboardRequest, callback: google.monitoring.dashboard.v1.DashboardsService.UpdateDashboardCallback): void;

Calls UpdateDashboard.

Parameters
NameDescription
request google.monitoring.dashboard.v1.IUpdateDashboardRequest

UpdateDashboardRequest message or plain object

callback google.monitoring.dashboard.v1.DashboardsService.UpdateDashboardCallback

Node-style callback called with the error, if any, and Dashboard

Returns
TypeDescription
void

updateDashboard(request)

public updateDashboard(request: google.monitoring.dashboard.v1.IUpdateDashboardRequest): Promise<google.monitoring.dashboard.v1.Dashboard>;

Calls UpdateDashboard.

Parameter
NameDescription
request google.monitoring.dashboard.v1.IUpdateDashboardRequest

UpdateDashboardRequest message or plain object

Returns
TypeDescription
Promise<google.monitoring.dashboard.v1.Dashboard>

Promise