Class AutoMlGrpc.AutoMlStub (2.42.0)

public static final class AutoMlGrpc.AutoMlStub extends AbstractAsyncStub<AutoMlGrpc.AutoMlStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > AutoMlGrpc.AutoMlStub

Methods

build(Channel channel, CallOptions callOptions)

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

createDataset(CreateDatasetRequest request, StreamObserver<Dataset> responseObserver)

public void createDataset(CreateDatasetRequest request, StreamObserver<Dataset> responseObserver)

Creates a dataset.

Parameters
Name Description
request CreateDatasetRequest
responseObserver io.grpc.stub.StreamObserver<Dataset>

createModel(CreateModelRequest request, StreamObserver<Operation> responseObserver)

public void createModel(CreateModelRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request CreateModelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteDataset(DeleteDatasetRequest request, StreamObserver<Operation> responseObserver)

public void deleteDataset(DeleteDatasetRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request DeleteDatasetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteModel(DeleteModelRequest request, StreamObserver<Operation> responseObserver)

public void deleteModel(DeleteModelRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteModelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deployModel(DeployModelRequest request, StreamObserver<Operation> responseObserver)

public void deployModel(DeployModelRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request DeployModelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

exportData(ExportDataRequest request, StreamObserver<Operation> responseObserver)

public void exportData(ExportDataRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request ExportDataRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

exportEvaluatedExamples(ExportEvaluatedExamplesRequest request, StreamObserver<Operation> responseObserver)

public void exportEvaluatedExamples(ExportEvaluatedExamplesRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request ExportEvaluatedExamplesRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

exportModel(ExportModelRequest request, StreamObserver<Operation> responseObserver)

public void exportModel(ExportModelRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request ExportModelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getAnnotationSpec(GetAnnotationSpecRequest request, StreamObserver<AnnotationSpec> responseObserver)

public void getAnnotationSpec(GetAnnotationSpecRequest request, StreamObserver<AnnotationSpec> responseObserver)

Gets an annotation spec.

Parameters
Name Description
request GetAnnotationSpecRequest
responseObserver io.grpc.stub.StreamObserver<AnnotationSpec>

getColumnSpec(GetColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

public void getColumnSpec(GetColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

Gets a column spec.

Parameters
Name Description
request GetColumnSpecRequest
responseObserver io.grpc.stub.StreamObserver<ColumnSpec>

getDataset(GetDatasetRequest request, StreamObserver<Dataset> responseObserver)

public void getDataset(GetDatasetRequest request, StreamObserver<Dataset> responseObserver)

Gets a dataset.

Parameters
Name Description
request GetDatasetRequest
responseObserver io.grpc.stub.StreamObserver<Dataset>

getModel(GetModelRequest request, StreamObserver<Model> responseObserver)

public void getModel(GetModelRequest request, StreamObserver<Model> responseObserver)

Gets a model.

Parameters
Name Description
request GetModelRequest
responseObserver io.grpc.stub.StreamObserver<Model>

getModelEvaluation(GetModelEvaluationRequest request, StreamObserver<ModelEvaluation> responseObserver)

public void getModelEvaluation(GetModelEvaluationRequest request, StreamObserver<ModelEvaluation> responseObserver)

Gets a model evaluation.

Parameters
Name Description
request GetModelEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<ModelEvaluation>

getTableSpec(GetTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

public void getTableSpec(GetTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

Gets a table spec.

Parameters
Name Description
request GetTableSpecRequest
responseObserver io.grpc.stub.StreamObserver<TableSpec>

importData(ImportDataRequest request, StreamObserver<Operation> responseObserver)

public void importData(ImportDataRequest request, StreamObserver<Operation> responseObserver)

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.
Parameters
Name Description
request ImportDataRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listColumnSpecs(ListColumnSpecsRequest request, StreamObserver<ListColumnSpecsResponse> responseObserver)

public void listColumnSpecs(ListColumnSpecsRequest request, StreamObserver<ListColumnSpecsResponse> responseObserver)

Lists column specs in a table spec.

Parameters
Name Description
request ListColumnSpecsRequest
responseObserver io.grpc.stub.StreamObserver<ListColumnSpecsResponse>

listDatasets(ListDatasetsRequest request, StreamObserver<ListDatasetsResponse> responseObserver)

public void listDatasets(ListDatasetsRequest request, StreamObserver<ListDatasetsResponse> responseObserver)

Lists datasets in a project.

Parameters
Name Description
request ListDatasetsRequest
responseObserver io.grpc.stub.StreamObserver<ListDatasetsResponse>

listModelEvaluations(ListModelEvaluationsRequest request, StreamObserver<ListModelEvaluationsResponse> responseObserver)

public void listModelEvaluations(ListModelEvaluationsRequest request, StreamObserver<ListModelEvaluationsResponse> responseObserver)

Lists model evaluations.

Parameters
Name Description
request ListModelEvaluationsRequest
responseObserver io.grpc.stub.StreamObserver<ListModelEvaluationsResponse>

listModels(ListModelsRequest request, StreamObserver<ListModelsResponse> responseObserver)

public void listModels(ListModelsRequest request, StreamObserver<ListModelsResponse> responseObserver)

Lists models.

Parameters
Name Description
request ListModelsRequest
responseObserver io.grpc.stub.StreamObserver<ListModelsResponse>

listTableSpecs(ListTableSpecsRequest request, StreamObserver<ListTableSpecsResponse> responseObserver)

public void listTableSpecs(ListTableSpecsRequest request, StreamObserver<ListTableSpecsResponse> responseObserver)

Lists table specs in a dataset.

Parameters
Name Description
request ListTableSpecsRequest
responseObserver io.grpc.stub.StreamObserver<ListTableSpecsResponse>

undeployModel(UndeployModelRequest request, StreamObserver<Operation> responseObserver)

public void undeployModel(UndeployModelRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request UndeployModelRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateColumnSpec(UpdateColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

public void updateColumnSpec(UpdateColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

Updates a column spec.

Parameters
Name Description
request UpdateColumnSpecRequest
responseObserver io.grpc.stub.StreamObserver<ColumnSpec>

updateDataset(UpdateDatasetRequest request, StreamObserver<Dataset> responseObserver)

public void updateDataset(UpdateDatasetRequest request, StreamObserver<Dataset> responseObserver)

Updates a dataset.

Parameters
Name Description
request UpdateDatasetRequest
responseObserver io.grpc.stub.StreamObserver<Dataset>

updateTableSpec(UpdateTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

public void updateTableSpec(UpdateTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

Updates a table spec.

Parameters
Name Description
request UpdateTableSpecRequest
responseObserver io.grpc.stub.StreamObserver<TableSpec>