Class protos.google.cloud.retail.v2alpha.ModelService (3.5.0)

Represents a ModelService

Inheritance

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

Package

@google-cloud/retail

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

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

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

createModel(request, callback)

public createModel(request: google.cloud.retail.v2alpha.ICreateModelRequest, callback: google.cloud.retail.v2alpha.ModelService.CreateModelCallback): void;

Calls CreateModel.

Parameters
Name Description
request ICreateModelRequest

CreateModelRequest message or plain object
callback CreateModelCallback

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

createModel(request)

public createModel(request: google.cloud.retail.v2alpha.ICreateModelRequest): Promise<google.longrunning.Operation>;

Calls CreateModel.

Parameter
Name Description
request ICreateModelRequest

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

Promise

deleteModel(request, callback)

public deleteModel(request: google.cloud.retail.v2alpha.IDeleteModelRequest, callback: google.cloud.retail.v2alpha.ModelService.DeleteModelCallback): void;

Calls DeleteModel.

Parameters
Name Description
request IDeleteModelRequest

DeleteModelRequest message or plain object
callback DeleteModelCallback

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

deleteModel(request)

public deleteModel(request: google.cloud.retail.v2alpha.IDeleteModelRequest): Promise<google.protobuf.Empty>;

Calls DeleteModel.

Parameter
Name Description
request IDeleteModelRequest

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

Promise

getModel(request, callback)

public getModel(request: google.cloud.retail.v2alpha.IGetModelRequest, callback: google.cloud.retail.v2alpha.ModelService.GetModelCallback): void;

Calls GetModel.

Parameters
Name Description
request IGetModelRequest

GetModelRequest message or plain object
callback GetModelCallback

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

getModel(request)

public getModel(request: google.cloud.retail.v2alpha.IGetModelRequest): Promise<google.cloud.retail.v2alpha.Model>;

Calls GetModel.

Parameter
Name Description
request IGetModelRequest

GetModelRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2alpha.Model>

Promise

listModels(request, callback)

public listModels(request: google.cloud.retail.v2alpha.IListModelsRequest, callback: google.cloud.retail.v2alpha.ModelService.ListModelsCallback): void;

Calls ListModels.

Parameters
Name Description
request IListModelsRequest

ListModelsRequest message or plain object
callback ListModelsCallback

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

listModels(request)

public listModels(request: google.cloud.retail.v2alpha.IListModelsRequest): Promise<google.cloud.retail.v2alpha.ListModelsResponse>;

Calls ListModels.

Parameter
Name Description
request IListModelsRequest

ListModelsRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2alpha.ListModelsResponse>

Promise

pauseModel(request, callback)

public pauseModel(request: google.cloud.retail.v2alpha.IPauseModelRequest, callback: google.cloud.retail.v2alpha.ModelService.PauseModelCallback): void;

Calls PauseModel.

Parameters
Name Description
request IPauseModelRequest

PauseModelRequest message or plain object
callback PauseModelCallback

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

pauseModel(request)

public pauseModel(request: google.cloud.retail.v2alpha.IPauseModelRequest): Promise<google.cloud.retail.v2alpha.Model>;

Calls PauseModel.

Parameter
Name Description
request IPauseModelRequest

PauseModelRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2alpha.Model>

Promise

resumeModel(request, callback)

public resumeModel(request: google.cloud.retail.v2alpha.IResumeModelRequest, callback: google.cloud.retail.v2alpha.ModelService.ResumeModelCallback): void;

Calls ResumeModel.

Parameters
Name Description
request IResumeModelRequest

ResumeModelRequest message or plain object
callback ResumeModelCallback

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

resumeModel(request)

public resumeModel(request: google.cloud.retail.v2alpha.IResumeModelRequest): Promise<google.cloud.retail.v2alpha.Model>;

Calls ResumeModel.

Parameter
Name Description
request IResumeModelRequest

ResumeModelRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2alpha.Model>

Promise

tuneModel(request, callback)

public tuneModel(request: google.cloud.retail.v2alpha.ITuneModelRequest, callback: google.cloud.retail.v2alpha.ModelService.TuneModelCallback): void;

Calls TuneModel.

Parameters
Name Description
request ITuneModelRequest

TuneModelRequest message or plain object
callback TuneModelCallback

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

tuneModel(request)

public tuneModel(request: google.cloud.retail.v2alpha.ITuneModelRequest): Promise<google.longrunning.Operation>;

Calls TuneModel.

Parameter
Name Description
request ITuneModelRequest

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

Promise

updateModel(request, callback)

public updateModel(request: google.cloud.retail.v2alpha.IUpdateModelRequest, callback: google.cloud.retail.v2alpha.ModelService.UpdateModelCallback): void;

Calls UpdateModel.

Parameters
Name Description
request IUpdateModelRequest

UpdateModelRequest message or plain object
callback UpdateModelCallback

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

updateModel(request)

public updateModel(request: google.cloud.retail.v2alpha.IUpdateModelRequest): Promise<google.cloud.retail.v2alpha.Model>;

Calls UpdateModel.

Parameter
Name Description
request IUpdateModelRequest

UpdateModelRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2alpha.Model>

Promise