Class ModelServiceGrpc.ModelServiceFutureStub (2.45.0)

public static final class ModelServiceGrpc.ModelServiceFutureStub extends AbstractFutureStub<ModelServiceGrpc.ModelServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service ModelService.

Service for performing CRUD operations on models. Recommendation models contain all the metadata necessary to generate a set of models for the Predict() API. A model is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g. Frequently Bought Together on Home Page). This service allows you to do the following:

  • Initiate training of a model.
  • Pause training of an existing model.
  • List all the available models along with their metadata.
  • Control their tuning schedule.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ModelServiceGrpc.ModelServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected ModelServiceGrpc.ModelServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
ModelServiceGrpc.ModelServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createModel(CreateModelRequest request)

public ListenableFuture<Operation> createModel(CreateModelRequest request)

Creates a new model.

Parameter
Name Description
request CreateModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteModel(DeleteModelRequest request)

public ListenableFuture<Empty> deleteModel(DeleteModelRequest request)

Deletes an existing model.

Parameter
Name Description
request DeleteModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getModel(GetModelRequest request)

public ListenableFuture<Model> getModel(GetModelRequest request)

Gets a model.

Parameter
Name Description
request GetModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Model>

listModels(ListModelsRequest request)

public ListenableFuture<ListModelsResponse> listModels(ListModelsRequest request)

Lists all the models linked to this event store.

Parameter
Name Description
request ListModelsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListModelsResponse>

pauseModel(PauseModelRequest request)

public ListenableFuture<Model> pauseModel(PauseModelRequest request)

Pauses the training of an existing model.

Parameter
Name Description
request PauseModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Model>

resumeModel(ResumeModelRequest request)

public ListenableFuture<Model> resumeModel(ResumeModelRequest request)

Resumes the training of an existing model.

Parameter
Name Description
request ResumeModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Model>

tuneModel(TuneModelRequest request)

public ListenableFuture<Operation> tuneModel(TuneModelRequest request)

Tunes an existing model.

Parameter
Name Description
request TuneModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateModel(UpdateModelRequest request)

public ListenableFuture<Model> updateModel(UpdateModelRequest request)

Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them.

Parameter
Name Description
request UpdateModelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Model>