com.google.cloud.automl.v1beta1

Class AutoMlGrpc.AutoMlFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<AutoMlGrpc.AutoMlFutureStub>

com.google.cloud.automl.v1beta1.AutoMlGrpc.AutoMlFutureStub

Enclosing class:

AutoMlGrpc

public static final class AutoMlGrpc.AutoMlFutureStub
extends io.grpc.stub.AbstractStub<AutoMlGrpc.AutoMlFutureStub>

 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.
 

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

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, newStub, newStub, 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 AutoMlGrpc.AutoMlFutureStub build(io.grpc.Channel channel,
                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<AutoMlGrpc.AutoMlFutureStub>

createDataset

public com.google.common.util.concurrent.ListenableFuture<Dataset> createDataset(CreateDatasetRequest request)

 Creates a dataset.
 

getDataset

public com.google.common.util.concurrent.ListenableFuture<Dataset> getDataset(GetDatasetRequest request)

 Gets a dataset.
 

listDatasets

public com.google.common.util.concurrent.ListenableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest request)

 Lists datasets in a project.
 

updateDataset

public com.google.common.util.concurrent.ListenableFuture<Dataset> updateDataset(UpdateDatasetRequest request)

 Updates a dataset.
 

deleteDataset

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteDataset(DeleteDatasetRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][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

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> exportData(ExportDataRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<AnnotationSpec> getAnnotationSpec(GetAnnotationSpecRequest request)

 Gets an annotation spec.
 

getTableSpec

public com.google.common.util.concurrent.ListenableFuture<TableSpec> getTableSpec(GetTableSpecRequest request)

 Gets a table spec.
 

listTableSpecs

public com.google.common.util.concurrent.ListenableFuture<ListTableSpecsResponse> listTableSpecs(ListTableSpecsRequest request)

 Lists table specs in a dataset.
 

updateTableSpec

public com.google.common.util.concurrent.ListenableFuture<TableSpec> updateTableSpec(UpdateTableSpecRequest request)

 Updates a table spec.
 

getColumnSpec

public com.google.common.util.concurrent.ListenableFuture<ColumnSpec> getColumnSpec(GetColumnSpecRequest request)

 Gets a column spec.
 

listColumnSpecs

public com.google.common.util.concurrent.ListenableFuture<ListColumnSpecsResponse> listColumnSpecs(ListColumnSpecsRequest request)

 Lists column specs in a table spec.
 

updateColumnSpec

public com.google.common.util.concurrent.ListenableFuture<ColumnSpec> updateColumnSpec(UpdateColumnSpecRequest request)

 Updates a column spec.
 

createModel

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

 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

public com.google.common.util.concurrent.ListenableFuture<Model> getModel(GetModelRequest request)

 Gets a model.
 

listModels

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

 Lists models.
 

deleteModel

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteModel(DeleteModelRequest request)

 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

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][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 and Tables; all other domains manage deployment automatically.
 Returns an empty response in the
 [response][google.longrunning.Operation.response] field when it completes.
 

undeployModel

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][google.longrunning.Operation.response] field when it completes.
 

exportModel

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][google.cloud.automl.v1beta1.ModelExportOutputConfig].
 Returns an empty response in the
 [response][google.longrunning.Operation.response] field when it completes.
 

exportEvaluatedExamples

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][google.longrunning.Operation.response] field when it completes.
 

getModelEvaluation

public com.google.common.util.concurrent.ListenableFuture<ModelEvaluation> getModelEvaluation(GetModelEvaluationRequest request)

 Gets a model evaluation.
 

listModelEvaluations

public com.google.common.util.concurrent.ListenableFuture<ListModelEvaluationsResponse> listModelEvaluations(ListModelEvaluationsRequest request)

 Lists model evaluations.