Class protos.google.cloud.discoveryengine.v1.EngineService (2.2.0)

Represents an EngineService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1.EngineService

Package

@google-cloud/discoveryengine

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

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

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

createEngine(request, callback)

public createEngine(request: google.cloud.discoveryengine.v1.ICreateEngineRequest, callback: google.cloud.discoveryengine.v1.EngineService.CreateEngineCallback): void;

Calls CreateEngine.

Parameters
Name Description
request ICreateEngineRequest

CreateEngineRequest message or plain object
callback CreateEngineCallback

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

createEngine(request)

public createEngine(request: google.cloud.discoveryengine.v1.ICreateEngineRequest): Promise<google.longrunning.Operation>;

Calls CreateEngine.

Parameter
Name Description
request ICreateEngineRequest

CreateEngineRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteEngine(request, callback)

public deleteEngine(request: google.cloud.discoveryengine.v1.IDeleteEngineRequest, callback: google.cloud.discoveryengine.v1.EngineService.DeleteEngineCallback): void;

Calls DeleteEngine.

Parameters
Name Description
request IDeleteEngineRequest

DeleteEngineRequest message or plain object
callback DeleteEngineCallback

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

deleteEngine(request)

public deleteEngine(request: google.cloud.discoveryengine.v1.IDeleteEngineRequest): Promise<google.longrunning.Operation>;

Calls DeleteEngine.

Parameter
Name Description
request IDeleteEngineRequest

DeleteEngineRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getEngine(request, callback)

public getEngine(request: google.cloud.discoveryengine.v1.IGetEngineRequest, callback: google.cloud.discoveryengine.v1.EngineService.GetEngineCallback): void;

Calls GetEngine.

Parameters
Name Description
request IGetEngineRequest

GetEngineRequest message or plain object
callback GetEngineCallback

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

getEngine(request)

public getEngine(request: google.cloud.discoveryengine.v1.IGetEngineRequest): Promise<google.cloud.discoveryengine.v1.Engine>;

Calls GetEngine.

Parameter
Name Description
request IGetEngineRequest

GetEngineRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.Engine>

Promise

listEngines(request, callback)

public listEngines(request: google.cloud.discoveryengine.v1.IListEnginesRequest, callback: google.cloud.discoveryengine.v1.EngineService.ListEnginesCallback): void;

Calls ListEngines.

Parameters
Name Description
request IListEnginesRequest

ListEnginesRequest message or plain object
callback ListEnginesCallback

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

listEngines(request)

public listEngines(request: google.cloud.discoveryengine.v1.IListEnginesRequest): Promise<google.cloud.discoveryengine.v1.ListEnginesResponse>;

Calls ListEngines.

Parameter
Name Description
request IListEnginesRequest

ListEnginesRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.ListEnginesResponse>

Promise

updateEngine(request, callback)

public updateEngine(request: google.cloud.discoveryengine.v1.IUpdateEngineRequest, callback: google.cloud.discoveryengine.v1.EngineService.UpdateEngineCallback): void;

Calls UpdateEngine.

Parameters
Name Description
request IUpdateEngineRequest

UpdateEngineRequest message or plain object
callback UpdateEngineCallback

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

updateEngine(request)

public updateEngine(request: google.cloud.discoveryengine.v1.IUpdateEngineRequest): Promise<google.cloud.discoveryengine.v1.Engine>;

Calls UpdateEngine.

Parameter
Name Description
request IUpdateEngineRequest

UpdateEngineRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.Engine>

Promise