Class protos.google.monitoring.dashboard.v1.DashboardsService (2.6.1)

Version 2.6.1

• 2.9.2 (latest)
• 2.9.1
• 2.8.0
• 2.6.1
• 2.5.1
• 2.4.2
• 2.3.4

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

Name	Description
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

Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns

Type	Description
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

Name	Description
request	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

Type	Description
void

createDashboard(request)

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

Calls CreateDashboard.

Parameter

Name	Description
request	ICreateDashboardRequest CreateDashboardRequest message or plain object

Returns

Type	Description
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

Name	Description
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

Type	Description
void

deleteDashboard(request)

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

Calls DeleteDashboard.

Parameter

Name	Description
request	google.monitoring.dashboard.v1.IDeleteDashboardRequest DeleteDashboardRequest message or plain object

Returns

Type	Description
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

Name	Description
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

Type	Description
void

getDashboard(request)

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

Calls GetDashboard.

Parameter

Name	Description
request	google.monitoring.dashboard.v1.IGetDashboardRequest GetDashboardRequest message or plain object

Returns

Type	Description
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

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

Type	Description
void

listDashboards(request)

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

Calls ListDashboards.

Parameter

Name	Description
request	google.monitoring.dashboard.v1.IListDashboardsRequest ListDashboardsRequest message or plain object

Returns

Type	Description
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

Name	Description
request	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

Type	Description
void

updateDashboard(request)

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

Calls UpdateDashboard.

Parameter

Name	Description
request	IUpdateDashboardRequest UpdateDashboardRequest message or plain object

Returns

Type	Description
Promise<google.monitoring.dashboard.v1.Dashboard>	Promise