ServingConfigService

google .cloud .retail .v2. ServingConfigService

Represents a ServingConfigService

Constructor

new ServingConfigService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

addControl(request, callback) → {undefined}

Calls AddControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IAddControlRequest	AddControlRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.AddControlCallback	Node-style callback called with the error, if any, and ServingConfig

Returns:

Type	Description
undefined

addControl(request) → {Promise.<google.cloud.retail.v2.ServingConfig>}

Calls AddControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IAddControlRequest	AddControlRequest message or plain object

Returns:

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

createServingConfig(request, callback) → {undefined}

Calls CreateServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.ICreateServingConfigRequest	CreateServingConfigRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.CreateServingConfigCallback	Node-style callback called with the error, if any, and ServingConfig

Returns:

Type	Description
undefined

createServingConfig(request) → {Promise.<google.cloud.retail.v2.ServingConfig>}

Calls CreateServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.ICreateServingConfigRequest	CreateServingConfigRequest message or plain object

Returns:

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

deleteServingConfig(request, callback) → {undefined}

Calls DeleteServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IDeleteServingConfigRequest	DeleteServingConfigRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.DeleteServingConfigCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

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

Calls DeleteServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IDeleteServingConfigRequest	DeleteServingConfigRequest message or plain object

Returns:

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

getServingConfig(request, callback) → {undefined}

Calls GetServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetServingConfigRequest	GetServingConfigRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.GetServingConfigCallback	Node-style callback called with the error, if any, and ServingConfig

Returns:

Type	Description
undefined

getServingConfig(request) → {Promise.<google.cloud.retail.v2.ServingConfig>}

Calls GetServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IGetServingConfigRequest	GetServingConfigRequest message or plain object

Returns:

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

listServingConfigs(request, callback) → {undefined}

Calls ListServingConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IListServingConfigsRequest	ListServingConfigsRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.ListServingConfigsCallback	Node-style callback called with the error, if any, and ListServingConfigsResponse

Returns:

Type	Description
undefined

listServingConfigs(request) → {Promise.<google.cloud.retail.v2.ListServingConfigsResponse>}

Calls ListServingConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IListServingConfigsRequest	ListServingConfigsRequest message or plain object

Returns:

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

removeControl(request, callback) → {undefined}

Calls RemoveControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IRemoveControlRequest	RemoveControlRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.RemoveControlCallback	Node-style callback called with the error, if any, and ServingConfig

Returns:

Type	Description
undefined

removeControl(request) → {Promise.<google.cloud.retail.v2.ServingConfig>}

Calls RemoveControl.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IRemoveControlRequest	RemoveControlRequest message or plain object

Returns:

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

updateServingConfig(request, callback) → {undefined}

Calls UpdateServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateServingConfigRequest	UpdateServingConfigRequest message or plain object
`callback`	google.cloud.retail.v2.ServingConfigService.UpdateServingConfigCallback	Node-style callback called with the error, if any, and ServingConfig

Returns:

Type	Description
undefined

updateServingConfig(request) → {Promise.<google.cloud.retail.v2.ServingConfig>}

Calls UpdateServingConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2.IUpdateServingConfigRequest	UpdateServingConfigRequest message or plain object

Returns:

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

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

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

Type Definitions

AddControlCallback(error, responseopt)

Callback as used by addControl.

Parameters:

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

CreateServingConfigCallback(error, responseopt)

Callback as used by createServingConfig.

Parameters:

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

DeleteServingConfigCallback(error, responseopt)

Callback as used by deleteServingConfig.

Parameters:

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

GetServingConfigCallback(error, responseopt)

Callback as used by getServingConfig.

Parameters:

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

ListServingConfigsCallback(error, responseopt)

Callback as used by listServingConfigs.

Parameters:

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

RemoveControlCallback(error, responseopt)

Callback as used by removeControl.

Parameters:

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

UpdateServingConfigCallback(error, responseopt)

Callback as used by updateServingConfig.

Parameters:

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