com.google.cloud.automl.v1beta1

Interface AutoMlGrpc.AsyncService

All Known Implementing Classes:

AutoMlGrpc.AutoMlImplBase

Enclosing class:

AutoMlGrpc

public static interface AutoMlGrpc.AsyncService

 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.
 

Method Summary

Modifier and Type	Method and Description
default void	createDataset(CreateDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver) Creates a dataset.
default void	createModel(CreateModelRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a model.
default void	deleteDataset(DeleteDatasetRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes a dataset and all of its contents.
default void	deleteModel(DeleteModelRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes a model.
default void	deployModel(DeployModelRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deploys a model.
default void	exportData(ExportDataRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Exports dataset's data to the provided output location.
default void	exportEvaluatedExamples(ExportEvaluatedExamplesRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Exports examples on which the model was evaluated (i.e.
default void	exportModel(ExportModelRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Exports a trained, "export-able", model to a user specified Google Cloud Storage location.
default void	getAnnotationSpec(GetAnnotationSpecRequest request, io.grpc.stub.StreamObserver<AnnotationSpec> responseObserver) Gets an annotation spec.
default void	getColumnSpec(GetColumnSpecRequest request, io.grpc.stub.StreamObserver<ColumnSpec> responseObserver) Gets a column spec.
default void	getDataset(GetDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver) Gets a dataset.
default void	getModel(GetModelRequest request, io.grpc.stub.StreamObserver<Model> responseObserver) Gets a model.
default void	getModelEvaluation(GetModelEvaluationRequest request, io.grpc.stub.StreamObserver<ModelEvaluation> responseObserver) Gets a model evaluation.
default void	getTableSpec(GetTableSpecRequest request, io.grpc.stub.StreamObserver<TableSpec> responseObserver) Gets a table spec.
default void	importData(ImportDataRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Imports data into a dataset.
default void	listColumnSpecs(ListColumnSpecsRequest request, io.grpc.stub.StreamObserver<ListColumnSpecsResponse> responseObserver) Lists column specs in a table spec.
default void	listDatasets(ListDatasetsRequest request, io.grpc.stub.StreamObserver<ListDatasetsResponse> responseObserver) Lists datasets in a project.
default void	listModelEvaluations(ListModelEvaluationsRequest request, io.grpc.stub.StreamObserver<ListModelEvaluationsResponse> responseObserver) Lists model evaluations.
default void	listModels(ListModelsRequest request, io.grpc.stub.StreamObserver<ListModelsResponse> responseObserver) Lists models.
default void	listTableSpecs(ListTableSpecsRequest request, io.grpc.stub.StreamObserver<ListTableSpecsResponse> responseObserver) Lists table specs in a dataset.
default void	undeployModel(UndeployModelRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Undeploys a model.
default void	updateColumnSpec(UpdateColumnSpecRequest request, io.grpc.stub.StreamObserver<ColumnSpec> responseObserver) Updates a column spec.
default void	updateDataset(UpdateDatasetRequest request, io.grpc.stub.StreamObserver<Dataset> responseObserver) Updates a dataset.
default void	updateTableSpec(UpdateTableSpecRequest request, io.grpc.stub.StreamObserver<TableSpec> responseObserver) Updates a table spec.

Method Detail

createDataset

default void createDataset(CreateDatasetRequest request,
                           io.grpc.stub.StreamObserver<Dataset> responseObserver)

 Creates a dataset.
 

getDataset

default void getDataset(GetDatasetRequest request,
                        io.grpc.stub.StreamObserver<Dataset> responseObserver)

 Gets a dataset.
 

listDatasets

default void listDatasets(ListDatasetsRequest request,
                          io.grpc.stub.StreamObserver<ListDatasetsResponse> responseObserver)

 Lists datasets in a project.
 

updateDataset

default void updateDataset(UpdateDatasetRequest request,
                           io.grpc.stub.StreamObserver<Dataset> responseObserver)

 Updates a dataset.
 

deleteDataset

default void deleteDataset(DeleteDatasetRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes a dataset and all of its contents.
 Returns empty response in the
 [response][google.longrunning.Operation.response] field when it completes,
 and `delete_details` in the
 [metadata][google.longrunning.Operation.metadata] field.
 

importData

default void importData(ImportDataRequest request,
                        io.grpc.stub.StreamObserver<com.google.longrunning.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][google.cloud.automl.v1beta1.InputConfig.params]
     parameter must be explicitly set.
 Returns an empty response in the
 [response][google.longrunning.Operation.response] field when it completes.
 

exportData

default void exportData(ExportDataRequest request,
                        io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

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

getAnnotationSpec

default void getAnnotationSpec(GetAnnotationSpecRequest request,
                               io.grpc.stub.StreamObserver<AnnotationSpec> responseObserver)

 Gets an annotation spec.
 

getTableSpec

default void getTableSpec(GetTableSpecRequest request,
                          io.grpc.stub.StreamObserver<TableSpec> responseObserver)

 Gets a table spec.
 

listTableSpecs

default void listTableSpecs(ListTableSpecsRequest request,
                            io.grpc.stub.StreamObserver<ListTableSpecsResponse> responseObserver)

 Lists table specs in a dataset.
 

updateTableSpec

default void updateTableSpec(UpdateTableSpecRequest request,
                             io.grpc.stub.StreamObserver<TableSpec> responseObserver)

 Updates a table spec.
 

getColumnSpec

default void getColumnSpec(GetColumnSpecRequest request,
                           io.grpc.stub.StreamObserver<ColumnSpec> responseObserver)

 Gets a column spec.
 

listColumnSpecs

default void listColumnSpecs(ListColumnSpecsRequest request,
                             io.grpc.stub.StreamObserver<ListColumnSpecsResponse> responseObserver)

 Lists column specs in a table spec.
 

updateColumnSpec

default void updateColumnSpec(UpdateColumnSpecRequest request,
                              io.grpc.stub.StreamObserver<ColumnSpec> responseObserver)

 Updates a column spec.
 

createModel

default void createModel(CreateModelRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Creates a model.
 Returns a Model in the [response][google.longrunning.Operation.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.
 

getModel

default void getModel(GetModelRequest request,
                      io.grpc.stub.StreamObserver<Model> responseObserver)

 Gets a model.
 

listModels

default void listModels(ListModelsRequest request,
                        io.grpc.stub.StreamObserver<ListModelsResponse> responseObserver)

 Lists models.
 

deleteModel

default void deleteModel(DeleteModelRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes a model.
 Returns `google.protobuf.Empty` in the
 [response][google.longrunning.Operation.response] field when it completes,
 and `delete_details` in the
 [metadata][google.longrunning.Operation.metadata] field.
 

deployModel

default void deployModel(DeployModelRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.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][google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata.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][google.longrunning.Operation.response] field when it completes.
 

undeployModel

default void undeployModel(UndeployModelRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.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][google.longrunning.Operation.response] field when it completes.
 

exportModel

default void exportModel(ExportModelRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.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][google.cloud.automl.v1beta1.ModelExportOutputConfig].
 Returns an empty response in the
 [response][google.longrunning.Operation.response] field when it completes.
 

exportEvaluatedExamples

default void exportEvaluatedExamples(ExportEvaluatedExamplesRequest request,
                                     io.grpc.stub.StreamObserver<com.google.longrunning.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][google.longrunning.Operation.response] field when it completes.
 

getModelEvaluation

default void getModelEvaluation(GetModelEvaluationRequest request,
                                io.grpc.stub.StreamObserver<ModelEvaluation> responseObserver)

 Gets a model evaluation.
 

listModelEvaluations

default void listModelEvaluations(ListModelEvaluationsRequest request,
                                  io.grpc.stub.StreamObserver<ListModelEvaluationsResponse> responseObserver)

 Lists model evaluations.