DashboardsService

google .monitoring .dashboard .v1. DashboardsService

Represents a DashboardsService

Constructor

new DashboardsService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new DashboardsService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createDashboard(request, callback) → {undefined}

Calls CreateDashboard.

Parameters:

Name	Type	Description
`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:

Type	Description
undefined

createDashboard(request) → {Promise.<google.monitoring.dashboard.v1.Dashboard>}

Calls CreateDashboard.

Parameters:

Name	Type	Description
`request`	google.monitoring.dashboard.v1.ICreateDashboardRequest	CreateDashboardRequest message or plain object

Returns:

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

deleteDashboard(request, callback) → {undefined}

Calls DeleteDashboard.

Parameters:

Name	Type	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
undefined

deleteDashboard(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteDashboard.

Parameters:

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

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getDashboard(request, callback) → {undefined}

Calls GetDashboard.

Parameters:

Name	Type	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
undefined

getDashboard(request) → {Promise.<google.monitoring.dashboard.v1.Dashboard>}

Calls GetDashboard.

Parameters:

Name	Type	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) → {undefined}

Calls ListDashboards.

Parameters:

Name	Type	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
undefined

listDashboards(request) → {Promise.<google.monitoring.dashboard.v1.ListDashboardsResponse>}

Calls ListDashboards.

Parameters:

Name	Type	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) → {undefined}

Calls UpdateDashboard.

Parameters:

Name	Type	Description
`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:

Type	Description
undefined

updateDashboard(request) → {Promise.<google.monitoring.dashboard.v1.Dashboard>}

Calls UpdateDashboard.

Parameters:

Name	Type	Description
`request`	google.monitoring.dashboard.v1.IUpdateDashboardRequest	UpdateDashboardRequest message or plain object

Returns:

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

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DashboardsService}

Creates new DashboardsService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

Type Definitions

CreateDashboardCallback(error, responseopt)

Callback as used by createDashboard.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.monitoring.dashboard.v1.Dashboard	<optional>	Dashboard

DeleteDashboardCallback(error, responseopt)

Callback as used by deleteDashboard.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetDashboardCallback(error, responseopt)

Callback as used by getDashboard.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.monitoring.dashboard.v1.Dashboard	<optional>	Dashboard

ListDashboardsCallback(error, responseopt)

Callback as used by listDashboards.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.monitoring.dashboard.v1.ListDashboardsResponse	<optional>	ListDashboardsResponse

UpdateDashboardCallback(error, responseopt)

Callback as used by updateDashboard.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.monitoring.dashboard.v1.Dashboard	<optional>	Dashboard