Class AutoMlGrpc.AutoMlFutureStub (2.47.0)

public static final class AutoMlGrpc.AutoMlFutureStub extends AbstractFutureStub<AutoMlGrpc.AutoMlFutureStub>

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

AutoML Server API. The resource names are assigned by the server. The server never reuses names that it has created after the resources with those names are deleted. An ID of a resource is the last element of the item's resource name. For projects/{project_id}/locations/{location_id}/datasets/{dataset_id}, then the id for the item is {dataset_id}. Currently the only supported location_id is "us-central1". On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > AutoMlGrpc.AutoMlFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected AutoMlGrpc.AutoMlFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`AutoMlGrpc.AutoMlFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDataset(CreateDatasetRequest request)

public ListenableFuture<Dataset> createDataset(CreateDatasetRequest request)

Creates a dataset.

Parameter
Name	Description
`request`	`CreateDatasetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Dataset>`

createModel(CreateModelRequest request)

public ListenableFuture<Operation> createModel(CreateModelRequest request)

Creates a model. Returns a Model in the response field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameter
Name	Description
`request`	`CreateModelRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteDataset(DeleteDatasetRequest request)

public ListenableFuture<Operation> deleteDataset(DeleteDatasetRequest request)

Deletes a dataset and all of its contents. Returns empty response in the response field when it completes, and delete_details in the metadata field.

Parameter
Name	Description
`request`	`DeleteDatasetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteModel(DeleteModelRequest request)

public ListenableFuture<Operation> deleteModel(DeleteModelRequest request)

Deletes a model. Returns google.protobuf.Empty in the response field when it completes, and delete_details in the metadata field.

Parameter
Name	Description
`request`	`DeleteModelRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deployModel(DeployModelRequest request)

public ListenableFuture<Operation> deployModel(DeployModelRequest request)

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing node_number) will reset the deployment state without pausing the model's availability. Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically. Returns an empty response in the response field when it completes.

Parameter
Name	Description
`request`	`DeployModelRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

exportData(ExportDataRequest request)

public ListenableFuture<Operation> exportData(ExportDataRequest request)

Exports dataset's data to the provided output location. Returns an empty response in the response field when it completes.

Parameter
Name	Description
`request`	`ExportDataRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

exportEvaluatedExamples(ExportEvaluatedExamplesRequest request)

public ListenableFuture<Operation> exportEvaluatedExamples(ExportEvaluatedExamplesRequest request)

Exports examples on which the model was evaluated (i.e. which were in the TEST set of the dataset the model was created from), together with their ground truth annotations and the annotations created (predicted) by the model. The examples, ground truth and predictions are exported in the state they were at the moment the model was evaluated. This export is available only for 30 days since the model evaluation is created. Currently only available for Tables. Returns an empty response in the response field when it completes.

Parameter
Name	Description
`request`	`ExportEvaluatedExamplesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

exportModel(ExportModelRequest request)

public ListenableFuture<Operation> exportModel(ExportModelRequest request)

Exports a trained, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in ModelExportOutputConfig. Returns an empty response in the response field when it completes.

Parameter
Name	Description
`request`	`ExportModelRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

getAnnotationSpec(GetAnnotationSpecRequest request)

public ListenableFuture<AnnotationSpec> getAnnotationSpec(GetAnnotationSpecRequest request)

Gets an annotation spec.

Parameter
Name	Description
`request`	`GetAnnotationSpecRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<AnnotationSpec>`

getColumnSpec(GetColumnSpecRequest request)

public ListenableFuture<ColumnSpec> getColumnSpec(GetColumnSpecRequest request)

Gets a column spec.

Parameter
Name	Description
`request`	`GetColumnSpecRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ColumnSpec>`

getDataset(GetDatasetRequest request)

public ListenableFuture<Dataset> getDataset(GetDatasetRequest request)

Gets a dataset.

Parameter
Name	Description
`request`	`GetDatasetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Dataset>`

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>`

getModelEvaluation(GetModelEvaluationRequest request)

public ListenableFuture<ModelEvaluation> getModelEvaluation(GetModelEvaluationRequest request)

Gets a model evaluation.

Parameter
Name	Description
`request`	`GetModelEvaluationRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ModelEvaluation>`

getTableSpec(GetTableSpecRequest request)

public ListenableFuture<TableSpec> getTableSpec(GetTableSpecRequest request)

Gets a table spec.

Parameter
Name	Description
`request`	`GetTableSpecRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<TableSpec>`

importData(ImportDataRequest request)

public ListenableFuture<Operation> importData(ImportDataRequest request)

Imports data into a dataset. For Tables this method can only be called on an empty Dataset. For Tables:

A schema_inference_version parameter must be explicitly set. Returns an empty response in the response field when it completes.

Parameter
Name	Description
`request`	`ImportDataRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

listColumnSpecs(ListColumnSpecsRequest request)

public ListenableFuture<ListColumnSpecsResponse> listColumnSpecs(ListColumnSpecsRequest request)

Lists column specs in a table spec.

Parameter
Name	Description
`request`	`ListColumnSpecsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListColumnSpecsResponse>`

listDatasets(ListDatasetsRequest request)

public ListenableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest request)

Lists datasets in a project.

Parameter
Name	Description
`request`	`ListDatasetsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListDatasetsResponse>`

listModelEvaluations(ListModelEvaluationsRequest request)

public ListenableFuture<ListModelEvaluationsResponse> listModelEvaluations(ListModelEvaluationsRequest request)

Lists model evaluations.

Parameter
Name	Description
`request`	`ListModelEvaluationsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListModelEvaluationsResponse>`

listModels(ListModelsRequest request)

public ListenableFuture<ListModelsResponse> listModels(ListModelsRequest request)

Lists models.

Parameter
Name	Description
`request`	`ListModelsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListModelsResponse>`

listTableSpecs(ListTableSpecsRequest request)

public ListenableFuture<ListTableSpecsResponse> listTableSpecs(ListTableSpecsRequest request)

Lists table specs in a dataset.

Parameter
Name	Description
`request`	`ListTableSpecsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListTableSpecsResponse>`

undeployModel(UndeployModelRequest request)

public ListenableFuture<Operation> undeployModel(UndeployModelRequest request)

Undeploys a model. If the model is not deployed this method has no effect. Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically. Returns an empty response in the response field when it completes.

Parameter
Name	Description
`request`	`UndeployModelRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateColumnSpec(UpdateColumnSpecRequest request)

public ListenableFuture<ColumnSpec> updateColumnSpec(UpdateColumnSpecRequest request)

Updates a column spec.

Parameter
Name	Description
`request`	`UpdateColumnSpecRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ColumnSpec>`

updateDataset(UpdateDatasetRequest request)

public ListenableFuture<Dataset> updateDataset(UpdateDatasetRequest request)

Updates a dataset.

Parameter
Name	Description
`request`	`UpdateDatasetRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Dataset>`

updateTableSpec(UpdateTableSpecRequest request)

public ListenableFuture<TableSpec> updateTableSpec(UpdateTableSpecRequest request)

Updates a table spec.

Parameter
Name	Description
`request`	`UpdateTableSpecRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<TableSpec>`