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

Represents a ControlService

Inheritance

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

Package

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.v2alpha.ICreateControlRequest, callback: google.cloud.retail.v2alpha.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.v2alpha.ICreateControlRequest): Promise<google.cloud.retail.v2alpha.Control>;

Calls CreateControl.

Parameter
Name	Description
`request`	`ICreateControlRequest` CreateControlRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.retail.v2alpha.Control>`	Promise

deleteControl(request, callback)

public deleteControl(request: google.cloud.retail.v2alpha.IDeleteControlRequest, callback: google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.IGetControlRequest, callback: google.cloud.retail.v2alpha.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.v2alpha.IGetControlRequest): Promise<google.cloud.retail.v2alpha.Control>;

Calls GetControl.

Parameter
Name	Description
`request`	`IGetControlRequest` GetControlRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.retail.v2alpha.Control>`	Promise

listControls(request, callback)

public listControls(request: google.cloud.retail.v2alpha.IListControlsRequest, callback: google.cloud.retail.v2alpha.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.v2alpha.IListControlsRequest): Promise<google.cloud.retail.v2alpha.ListControlsResponse>;

Calls ListControls.

Parameter
Name	Description
`request`	`IListControlsRequest` ListControlsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.retail.v2alpha.ListControlsResponse>`	Promise

updateControl(request, callback)

public updateControl(request: google.cloud.retail.v2alpha.IUpdateControlRequest, callback: google.cloud.retail.v2alpha.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.v2alpha.IUpdateControlRequest): Promise<google.cloud.retail.v2alpha.Control>;

Calls UpdateControl.

Parameter
Name	Description
`request`	`IUpdateControlRequest` UpdateControlRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.retail.v2alpha.Control>`	Promise