ControlService

google .cloud .retail .v2. ControlService

Represents a ControlService

Constructor

new ControlService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ControlService 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

createControl(request, callback) → {undefined}

Calls CreateControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.ICreateControlRequest	CreateControlRequest message or plain object
`callback`	google.cloud.retail.v2.ControlService.CreateControlCallback	Node-style callback called with the error, if any, and Control

Returns:

Type	Description
undefined

createControl(request) → {Promise.<google.cloud.retail.v2.Control>}

Calls CreateControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.ICreateControlRequest	CreateControlRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2.Control>	Promise

deleteControl(request, callback) → {undefined}

Calls DeleteControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IDeleteControlRequest	DeleteControlRequest message or plain object
`callback`	google.cloud.retail.v2.ControlService.DeleteControlCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

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

Calls DeleteControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IDeleteControlRequest	DeleteControlRequest message or plain object

Returns:

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

getControl(request, callback) → {undefined}

Calls GetControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetControlRequest	GetControlRequest message or plain object
`callback`	google.cloud.retail.v2.ControlService.GetControlCallback	Node-style callback called with the error, if any, and Control

Returns:

Type	Description
undefined

getControl(request) → {Promise.<google.cloud.retail.v2.Control>}

Calls GetControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetControlRequest	GetControlRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2.Control>	Promise

listControls(request, callback) → {undefined}

Calls ListControls.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IListControlsRequest	ListControlsRequest message or plain object
`callback`	google.cloud.retail.v2.ControlService.ListControlsCallback	Node-style callback called with the error, if any, and ListControlsResponse

Returns:

Type	Description
undefined

listControls(request) → {Promise.<google.cloud.retail.v2.ListControlsResponse>}

Calls ListControls.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IListControlsRequest	ListControlsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2.ListControlsResponse>	Promise

updateControl(request, callback) → {undefined}

Calls UpdateControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateControlRequest	UpdateControlRequest message or plain object
`callback`	google.cloud.retail.v2.ControlService.UpdateControlCallback	Node-style callback called with the error, if any, and Control

Returns:

Type	Description
undefined

updateControl(request) → {Promise.<google.cloud.retail.v2.Control>}

Calls UpdateControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateControlRequest	UpdateControlRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2.Control>	Promise

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

Creates new ControlService 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
ControlService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateControlCallback(error, responseopt)

Callback as used by createControl.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.Control	<optional>	Control

DeleteControlCallback(error, responseopt)

Callback as used by deleteControl.

Parameters:

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

GetControlCallback(error, responseopt)

Callback as used by getControl.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.Control	<optional>	Control

ListControlsCallback(error, responseopt)

Callback as used by listControls.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.ListControlsResponse	<optional>	ListControlsResponse

UpdateControlCallback(error, responseopt)

Callback as used by updateControl.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2.Control	<optional>	Control