Class protos.google.cloud.discoveryengine.v1alpha.EngineService (1.7.0)

Version latest

• 1.7.0 (latest)
• 1.6.0
• 1.4.1
• 1.3.1
• 1.2.0
• 1.0.0
• 0.6.0
• 0.5.0
• 0.3.1
• 0.2.0

Represents an EngineService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1alpha.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.v1alpha.ICreateEngineRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.IDeleteEngineRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.IGetEngineRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.IGetEngineRequest): Promise<google.cloud.discoveryengine.v1alpha.Engine>;

Calls GetEngine.

Parameter
Name	Description
request	IGetEngineRequest GetEngineRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Engine>	Promise

listEngines(request, callback)

public listEngines(request: google.cloud.discoveryengine.v1alpha.IListEnginesRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.IListEnginesRequest): Promise<google.cloud.discoveryengine.v1alpha.ListEnginesResponse>;

Calls ListEngines.

Parameter
Name	Description
request	IListEnginesRequest ListEnginesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.ListEnginesResponse>	Promise

pauseEngine(request, callback)

public pauseEngine(request: google.cloud.discoveryengine.v1alpha.IPauseEngineRequest, callback: google.cloud.discoveryengine.v1alpha.EngineService.PauseEngineCallback): void;

Calls PauseEngine.

Parameters
Name	Description
request	IPauseEngineRequest PauseEngineRequest message or plain object
callback	PauseEngineCallback Node-style callback called with the error, if any, and Engine

Returns
Type	Description
void

pauseEngine(request)

public pauseEngine(request: google.cloud.discoveryengine.v1alpha.IPauseEngineRequest): Promise<google.cloud.discoveryengine.v1alpha.Engine>;

Calls PauseEngine.

Parameter
Name	Description
request	IPauseEngineRequest PauseEngineRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Engine>	Promise

resumeEngine(request, callback)

public resumeEngine(request: google.cloud.discoveryengine.v1alpha.IResumeEngineRequest, callback: google.cloud.discoveryengine.v1alpha.EngineService.ResumeEngineCallback): void;

Calls ResumeEngine.

Parameters
Name	Description
request	IResumeEngineRequest ResumeEngineRequest message or plain object
callback	ResumeEngineCallback Node-style callback called with the error, if any, and Engine

Returns
Type	Description
void

resumeEngine(request)

public resumeEngine(request: google.cloud.discoveryengine.v1alpha.IResumeEngineRequest): Promise<google.cloud.discoveryengine.v1alpha.Engine>;

Calls ResumeEngine.

Parameter
Name	Description
request	IResumeEngineRequest ResumeEngineRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Engine>	Promise

tuneEngine(request, callback)

public tuneEngine(request: google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, callback: google.cloud.discoveryengine.v1alpha.EngineService.TuneEngineCallback): void;

Calls TuneEngine.

Parameters
Name	Description
request	ITuneEngineRequest TuneEngineRequest message or plain object
callback	TuneEngineCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

tuneEngine(request)

public tuneEngine(request: google.cloud.discoveryengine.v1alpha.ITuneEngineRequest): Promise<google.longrunning.Operation>;

Calls TuneEngine.

Parameter
Name	Description
request	ITuneEngineRequest TuneEngineRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateEngine(request, callback)

public updateEngine(request: google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest, callback: google.cloud.discoveryengine.v1alpha.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.v1alpha.IUpdateEngineRequest): Promise<google.cloud.discoveryengine.v1alpha.Engine>;

Calls UpdateEngine.

Parameter
Name	Description
request	IUpdateEngineRequest UpdateEngineRequest message or plain object

Returns
Type	Description
Promise<google.cloud.discoveryengine.v1alpha.Engine>	Promise