com.google.cloud.retail.v2beta

Class ModelServiceGrpc.ModelServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<ModelServiceGrpc.ModelServiceFutureStub>

com.google.cloud.retail.v2beta.ModelServiceGrpc.ModelServiceFutureStub

Enclosing class:

ModelServiceGrpc

public static final class ModelServiceGrpc.ModelServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<ModelServiceGrpc.ModelServiceFutureStub>

 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected ModelServiceGrpc.ModelServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createModel(CreateModelRequest request) Creates a new model.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteModel(DeleteModelRequest request) Deletes an existing model.
com.google.common.util.concurrent.ListenableFuture<ListModelsResponse>	listModels(ListModelsRequest request) Lists all the models linked to this event store.
com.google.common.util.concurrent.ListenableFuture<Model>	pauseModel(PauseModelRequest request) Pauses the training of an existing model.
com.google.common.util.concurrent.ListenableFuture<Model>	resumeModel(ResumeModelRequest request) Resumes the training of an existing model.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	tuneModel(TuneModelRequest request) Tunes an existing model.
com.google.common.util.concurrent.ListenableFuture<Model>	updateModel(UpdateModelRequest request) Update of model metadata.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected ModelServiceGrpc.ModelServiceFutureStub build(io.grpc.Channel channel,
                                                        io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ModelServiceGrpc.ModelServiceFutureStub>

createModel

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createModel(CreateModelRequest request)

 Creates a new model.
 

pauseModel

public com.google.common.util.concurrent.ListenableFuture<Model> pauseModel(PauseModelRequest request)

 Pauses the training of an existing model.
 

resumeModel

public com.google.common.util.concurrent.ListenableFuture<Model> resumeModel(ResumeModelRequest request)

 Resumes the training of an existing model.
 

deleteModel

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteModel(DeleteModelRequest request)

 Deletes an existing model.
 

listModels

public com.google.common.util.concurrent.ListenableFuture<ListModelsResponse> listModels(ListModelsRequest request)

 Lists all the models linked to this event store.
 

updateModel

public com.google.common.util.concurrent.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.
 

tuneModel

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> tuneModel(TuneModelRequest request)

 Tunes an existing model.