Class protos.google.cloud.retail.v2.ControlService (3.1.0)

Represents a ControlService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.retail.v2.ControlService

Package

@google-cloud/retail

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

Creates new ControlService 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
ControlService

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

createControl(request, callback)

public createControl(request: google.cloud.retail.v2.ICreateControlRequest, callback: google.cloud.retail.v2.ControlService.CreateControlCallback): void;

Calls CreateControl.

Parameters
Name Description
request ICreateControlRequest

CreateControlRequest message or plain object
callback CreateControlCallback

Node-style callback called with the error, if any, and Control
Returns
Type Description
void

createControl(request)

public createControl(request: google.cloud.retail.v2.ICreateControlRequest): Promise<google.cloud.retail.v2.Control>;

Calls CreateControl.

Parameter
Name Description
request ICreateControlRequest

CreateControlRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2.Control>

Promise

deleteControl(request, callback)

public deleteControl(request: google.cloud.retail.v2.IDeleteControlRequest, callback: google.cloud.retail.v2.ControlService.DeleteControlCallback): void;

Calls DeleteControl.

Parameters
Name Description
request IDeleteControlRequest

DeleteControlRequest message or plain object
callback DeleteControlCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteControl(request)

public deleteControl(request: google.cloud.retail.v2.IDeleteControlRequest): Promise<google.protobuf.Empty>;

Calls DeleteControl.

Parameter
Name Description
request IDeleteControlRequest

DeleteControlRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getControl(request, callback)

public getControl(request: google.cloud.retail.v2.IGetControlRequest, callback: google.cloud.retail.v2.ControlService.GetControlCallback): void;

Calls GetControl.

Parameters
Name Description
request IGetControlRequest

GetControlRequest message or plain object
callback GetControlCallback

Node-style callback called with the error, if any, and Control
Returns
Type Description
void

getControl(request)

public getControl(request: google.cloud.retail.v2.IGetControlRequest): Promise<google.cloud.retail.v2.Control>;

Calls GetControl.

Parameter
Name Description
request IGetControlRequest

GetControlRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2.Control>

Promise

listControls(request, callback)

public listControls(request: google.cloud.retail.v2.IListControlsRequest, callback: google.cloud.retail.v2.ControlService.ListControlsCallback): void;

Calls ListControls.

Parameters
Name Description
request IListControlsRequest

ListControlsRequest message or plain object
callback ListControlsCallback

Node-style callback called with the error, if any, and ListControlsResponse
Returns
Type Description
void

listControls(request)

public listControls(request: google.cloud.retail.v2.IListControlsRequest): Promise<google.cloud.retail.v2.ListControlsResponse>;

Calls ListControls.

Parameter
Name Description
request IListControlsRequest

ListControlsRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2.ListControlsResponse>

Promise

updateControl(request, callback)

public updateControl(request: google.cloud.retail.v2.IUpdateControlRequest, callback: google.cloud.retail.v2.ControlService.UpdateControlCallback): void;

Calls UpdateControl.

Parameters
Name Description
request IUpdateControlRequest

UpdateControlRequest message or plain object
callback UpdateControlCallback

Node-style callback called with the error, if any, and Control
Returns
Type Description
void

updateControl(request)

public updateControl(request: google.cloud.retail.v2.IUpdateControlRequest): Promise<google.cloud.retail.v2.Control>;

Calls UpdateControl.

Parameter
Name Description
request IUpdateControlRequest

UpdateControlRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2.Control>

Promise