Class AutoMlClient (2.55.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.createDataset(parent, dataset);
 }

Note: close() needs to be called on the AutoMlClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateDataset

Creates a dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDataset(CreateDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDataset(LocationName parent, Dataset dataset)

  • createDataset(String parent, Dataset dataset)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDatasetCallable()

GetDataset

Gets a dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataset(GetDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataset(DatasetName name)

  • getDataset(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDatasetCallable()

ListDatasets

Lists datasets in a project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDatasets(ListDatasetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDatasets(LocationName parent)

  • listDatasets(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDatasetsPagedCallable()

  • listDatasetsCallable()

UpdateDataset

Updates a dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDataset(UpdateDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDataset(Dataset dataset)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDatasetCallable()

DeleteDataset

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDatasetAsync(DeleteDatasetRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteDatasetAsync(DatasetName name)

  • deleteDatasetAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDatasetOperationCallable()

  • deleteDatasetCallable()

ImportData

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • importDataAsync(ImportDataRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • importDataAsync(DatasetName name, InputConfig inputConfig)

  • importDataAsync(String name, InputConfig inputConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • importDataOperationCallable()

  • importDataCallable()

ExportData

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportDataAsync(ExportDataRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • exportDataAsync(DatasetName name, OutputConfig outputConfig)

  • exportDataAsync(String name, OutputConfig outputConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportDataOperationCallable()

  • exportDataCallable()

GetAnnotationSpec

Gets an annotation spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAnnotationSpec(GetAnnotationSpecRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAnnotationSpec(AnnotationSpecName name)

  • getAnnotationSpec(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAnnotationSpecCallable()

GetTableSpec

Gets a table spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTableSpec(GetTableSpecRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTableSpec(TableSpecName name)

  • getTableSpec(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getTableSpecCallable()

ListTableSpecs

Lists table specs in a dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTableSpecs(ListTableSpecsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTableSpecs(DatasetName parent)

  • listTableSpecs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listTableSpecsPagedCallable()

  • listTableSpecsCallable()

UpdateTableSpec

Updates a table spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateTableSpec(UpdateTableSpecRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateTableSpec(TableSpec tableSpec)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateTableSpecCallable()

GetColumnSpec

Gets a column spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getColumnSpec(GetColumnSpecRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getColumnSpec(ColumnSpecName name)

  • getColumnSpec(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getColumnSpecCallable()

ListColumnSpecs

Lists column specs in a table spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listColumnSpecs(ListColumnSpecsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listColumnSpecs(TableSpecName parent)

  • listColumnSpecs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listColumnSpecsPagedCallable()

  • listColumnSpecsCallable()

UpdateColumnSpec

Updates a column spec.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateColumnSpec(UpdateColumnSpecRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateColumnSpec(ColumnSpec columnSpec)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateColumnSpecCallable()

CreateModel

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createModelAsync(CreateModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createModelAsync(LocationName parent, Model model)

  • createModelAsync(String parent, Model model)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createModelOperationCallable()

  • createModelCallable()

GetModel

Gets a model.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getModel(GetModelRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getModel(ModelName name)

  • getModel(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getModelCallable()

ListModels

Lists models.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listModels(ListModelsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listModels(LocationName parent)

  • listModels(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listModelsPagedCallable()

  • listModelsCallable()

DeleteModel

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteModelAsync(DeleteModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteModelAsync(ModelName name)

  • deleteModelAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteModelOperationCallable()

  • deleteModelCallable()

DeployModel

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deployModelAsync(DeployModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deployModelAsync(ModelName name)

  • deployModelAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deployModelOperationCallable()

  • deployModelCallable()

UndeployModel

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • undeployModelAsync(UndeployModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • undeployModelAsync(ModelName name)

  • undeployModelAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • undeployModelOperationCallable()

  • undeployModelCallable()

ExportModel

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportModelAsync(ExportModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • exportModelAsync(ModelName name, ModelExportOutputConfig outputConfig)

  • exportModelAsync(String name, ModelExportOutputConfig outputConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportModelOperationCallable()

  • exportModelCallable()

ExportEvaluatedExamples

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportEvaluatedExamplesAsync(ExportEvaluatedExamplesRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • exportEvaluatedExamplesAsync(ModelName name, ExportEvaluatedExamplesOutputConfig outputConfig)

  • exportEvaluatedExamplesAsync(String name, ExportEvaluatedExamplesOutputConfig outputConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportEvaluatedExamplesOperationCallable()

  • exportEvaluatedExamplesCallable()

GetModelEvaluation

Gets a model evaluation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getModelEvaluation(GetModelEvaluationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getModelEvaluation(ModelEvaluationName name)

  • getModelEvaluation(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getModelEvaluationCallable()

ListModelEvaluations

Lists model evaluations.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listModelEvaluations(ListModelEvaluationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listModelEvaluations(ModelName parent)

  • listModelEvaluations(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listModelEvaluationsPagedCallable()

  • listModelEvaluationsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AutoMlSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AutoMlSettings autoMlSettings =
     AutoMlSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AutoMlClient autoMlClient = AutoMlClient.create(autoMlSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AutoMlSettings autoMlSettings = AutoMlSettings.newBuilder().setEndpoint(myEndpoint).build();
 AutoMlClient autoMlClient = AutoMlClient.create(autoMlSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AutoMlSettings autoMlSettings = AutoMlSettings.newHttpJsonBuilder().build();
 AutoMlClient autoMlClient = AutoMlClient.create(autoMlSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > AutoMlClient

Static Methods

create()

public static final AutoMlClient create()

Constructs an instance of AutoMlClient with default settings.

Returns
Type Description
AutoMlClient
Exceptions
Type Description
IOException

create(AutoMlSettings settings)

public static final AutoMlClient create(AutoMlSettings settings)

Constructs an instance of AutoMlClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings AutoMlSettings
Returns
Type Description
AutoMlClient
Exceptions
Type Description
IOException

create(AutoMlStub stub)

public static final AutoMlClient create(AutoMlStub stub)

Constructs an instance of AutoMlClient, using the given stub for making calls. This is for advanced usage - prefer using create(AutoMlSettings).

Parameter
Name Description
stub AutoMlStub
Returns
Type Description
AutoMlClient

Constructors

AutoMlClient(AutoMlSettings settings)

protected AutoMlClient(AutoMlSettings settings)

Constructs an instance of AutoMlClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings AutoMlSettings

AutoMlClient(AutoMlStub stub)

protected AutoMlClient(AutoMlStub stub)
Parameter
Name Description
stub AutoMlStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createDataset(CreateDatasetRequest request)

public final Dataset createDataset(CreateDatasetRequest request)

Creates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   Dataset response = autoMlClient.createDataset(request);
 }
Parameter
Name Description
request CreateDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Dataset

createDataset(LocationName parent, Dataset dataset)

public final Dataset createDataset(LocationName parent, Dataset dataset)

Creates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.createDataset(parent, dataset);
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the project to create the dataset for.
dataset Dataset

Required. The dataset to create.
Returns
Type Description
Dataset

createDataset(String parent, Dataset dataset)

public final Dataset createDataset(String parent, Dataset dataset)

Creates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.createDataset(parent, dataset);
 }
Parameters
Name Description
parent String

Required. The resource name of the project to create the dataset for.
dataset Dataset

Required. The dataset to create.
Returns
Type Description
Dataset

createDatasetCallable()

public final UnaryCallable<CreateDatasetRequest,Dataset> createDatasetCallable()

Creates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   ApiFuture<Dataset> future = autoMlClient.createDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDatasetRequest,Dataset>

createModelAsync(CreateModelRequest request)

public final OperationFuture<Model,OperationMetadata> createModelAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   CreateModelRequest request =
       CreateModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModel(Model.newBuilder().build())
           .build();
   Model response = autoMlClient.createModelAsync(request).get();
 }
Parameter
Name Description
request CreateModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Model,OperationMetadata>

createModelAsync(LocationName parent, Model model)

public final OperationFuture<Model,OperationMetadata> createModelAsync(LocationName parent, Model model)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   Model response = autoMlClient.createModelAsync(parent, model).get();
 }
Parameters
Name Description
parent LocationName

Required. Resource name of the parent project where the model is being created.
model Model

Required. The model to create.
Returns
Type Description
OperationFuture<Model,OperationMetadata>

createModelAsync(String parent, Model model)

public final OperationFuture<Model,OperationMetadata> createModelAsync(String parent, Model model)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Model model = Model.newBuilder().build();
   Model response = autoMlClient.createModelAsync(parent, model).get();
 }
Parameters
Name Description
parent String

Required. Resource name of the parent project where the model is being created.
model Model

Required. The model to create.
Returns
Type Description
OperationFuture<Model,OperationMetadata>

createModelCallable()

public final UnaryCallable<CreateModelRequest,Operation> createModelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   CreateModelRequest request =
       CreateModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModel(Model.newBuilder().build())
           .build();
   ApiFuture<Operation> future = autoMlClient.createModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateModelRequest,Operation>

createModelOperationCallable()

public final OperationCallable<CreateModelRequest,Model,OperationMetadata> createModelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   CreateModelRequest request =
       CreateModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModel(Model.newBuilder().build())
           .build();
   OperationFuture<Model, OperationMetadata> future =
       autoMlClient.createModelOperationCallable().futureCall(request);
   // Do something.
   Model response = future.get();
 }
Returns
Type Description
OperationCallable<CreateModelRequest,Model,OperationMetadata>

deleteDatasetAsync(DatasetName name)

public final OperationFuture<Empty,OperationMetadata> deleteDatasetAsync(DatasetName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   autoMlClient.deleteDatasetAsync(name).get();
 }
Parameter
Name Description
name DatasetName

Required. The resource name of the dataset to delete.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDatasetAsync(DeleteDatasetRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDatasetAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   autoMlClient.deleteDatasetAsync(request).get();
 }
Parameter
Name Description
request DeleteDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDatasetAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteDatasetAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   autoMlClient.deleteDatasetAsync(name).get();
 }
Parameter
Name Description
name String

Required. The resource name of the dataset to delete.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDatasetCallable()

public final UnaryCallable<DeleteDatasetRequest,Operation> deleteDatasetCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   ApiFuture<Operation> future = autoMlClient.deleteDatasetCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDatasetRequest,Operation>

deleteDatasetOperationCallable()

public final OperationCallable<DeleteDatasetRequest,Empty,OperationMetadata> deleteDatasetOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.deleteDatasetOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteDatasetRequest,Empty,OperationMetadata>

deleteModelAsync(DeleteModelRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteModelAsync(DeleteModelRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeleteModelRequest request =
       DeleteModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   autoMlClient.deleteModelAsync(request).get();
 }
Parameter
Name Description
request DeleteModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteModelAsync(ModelName name)

public final OperationFuture<Empty,OperationMetadata> deleteModelAsync(ModelName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   autoMlClient.deleteModelAsync(name).get();
 }
Parameter
Name Description
name ModelName

Required. Resource name of the model being deleted.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteModelAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteModelAsync(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   autoMlClient.deleteModelAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name of the model being deleted.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteModelCallable()

public final UnaryCallable<DeleteModelRequest,Operation> deleteModelCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeleteModelRequest request =
       DeleteModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   ApiFuture<Operation> future = autoMlClient.deleteModelCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteModelRequest,Operation>

deleteModelOperationCallable()

public final OperationCallable<DeleteModelRequest,Empty,OperationMetadata> deleteModelOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeleteModelRequest request =
       DeleteModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.deleteModelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteModelRequest,Empty,OperationMetadata>

deployModelAsync(DeployModelRequest request)

public final OperationFuture<Empty,OperationMetadata> deployModelAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeployModelRequest request =
       DeployModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   autoMlClient.deployModelAsync(request).get();
 }
Parameter
Name Description
request DeployModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deployModelAsync(ModelName name)

public final OperationFuture<Empty,OperationMetadata> deployModelAsync(ModelName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   autoMlClient.deployModelAsync(name).get();
 }
Parameter
Name Description
name ModelName

Required. Resource name of the model to deploy.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deployModelAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deployModelAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   autoMlClient.deployModelAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name of the model to deploy.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deployModelCallable()

public final UnaryCallable<DeployModelRequest,Operation> deployModelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeployModelRequest request =
       DeployModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   ApiFuture<Operation> future = autoMlClient.deployModelCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeployModelRequest,Operation>

deployModelOperationCallable()

public final OperationCallable<DeployModelRequest,Empty,OperationMetadata> deployModelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DeployModelRequest request =
       DeployModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.deployModelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeployModelRequest,Empty,OperationMetadata>

exportDataAsync(DatasetName name, OutputConfig outputConfig)

public final OperationFuture<Empty,OperationMetadata> exportDataAsync(DatasetName name, OutputConfig outputConfig)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   autoMlClient.exportDataAsync(name, outputConfig).get();
 }
Parameters
Name Description
name DatasetName

Required. The resource name of the dataset.
outputConfig OutputConfig

Required. The desired output location.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportDataAsync(ExportDataRequest request)

public final OperationFuture<Empty,OperationMetadata> exportDataAsync(ExportDataRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .build();
   autoMlClient.exportDataAsync(request).get();
 }
Parameter
Name Description
request ExportDataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportDataAsync(String name, OutputConfig outputConfig)

public final OperationFuture<Empty,OperationMetadata> exportDataAsync(String name, OutputConfig outputConfig)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   autoMlClient.exportDataAsync(name, outputConfig).get();
 }
Parameters
Name Description
name String

Required. The resource name of the dataset.
outputConfig OutputConfig

Required. The desired output location.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportDataCallable()

public final UnaryCallable<ExportDataRequest,Operation> exportDataCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future = autoMlClient.exportDataCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ExportDataRequest,Operation>

exportDataOperationCallable()

public final OperationCallable<ExportDataRequest,Empty,OperationMetadata> exportDataOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.exportDataOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<ExportDataRequest,Empty,OperationMetadata>

exportEvaluatedExamplesAsync(ExportEvaluatedExamplesRequest request)

public final OperationFuture<Empty,OperationMetadata> exportEvaluatedExamplesAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportEvaluatedExamplesRequest request =
       ExportEvaluatedExamplesRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setOutputConfig(ExportEvaluatedExamplesOutputConfig.newBuilder().build())
           .build();
   autoMlClient.exportEvaluatedExamplesAsync(request).get();
 }
Parameter
Name Description
request ExportEvaluatedExamplesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportEvaluatedExamplesAsync(ModelName name, ExportEvaluatedExamplesOutputConfig outputConfig)

public final OperationFuture<Empty,OperationMetadata> exportEvaluatedExamplesAsync(ModelName name, ExportEvaluatedExamplesOutputConfig outputConfig)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ExportEvaluatedExamplesOutputConfig outputConfig =
       ExportEvaluatedExamplesOutputConfig.newBuilder().build();
   autoMlClient.exportEvaluatedExamplesAsync(name, outputConfig).get();
 }
Parameters
Name Description
name ModelName

Required. The resource name of the model whose evaluated examples are to be exported.
outputConfig ExportEvaluatedExamplesOutputConfig

Required. The desired output location and configuration.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportEvaluatedExamplesAsync(String name, ExportEvaluatedExamplesOutputConfig outputConfig)

public final OperationFuture<Empty,OperationMetadata> exportEvaluatedExamplesAsync(String name, ExportEvaluatedExamplesOutputConfig outputConfig)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   ExportEvaluatedExamplesOutputConfig outputConfig =
       ExportEvaluatedExamplesOutputConfig.newBuilder().build();
   autoMlClient.exportEvaluatedExamplesAsync(name, outputConfig).get();
 }
Parameters
Name Description
name String

Required. The resource name of the model whose evaluated examples are to be exported.
outputConfig ExportEvaluatedExamplesOutputConfig

Required. The desired output location and configuration.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportEvaluatedExamplesCallable()

public final UnaryCallable<ExportEvaluatedExamplesRequest,Operation> exportEvaluatedExamplesCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportEvaluatedExamplesRequest request =
       ExportEvaluatedExamplesRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setOutputConfig(ExportEvaluatedExamplesOutputConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       autoMlClient.exportEvaluatedExamplesCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ExportEvaluatedExamplesRequest,Operation>

exportEvaluatedExamplesOperationCallable()

public final OperationCallable<ExportEvaluatedExamplesRequest,Empty,OperationMetadata> exportEvaluatedExamplesOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportEvaluatedExamplesRequest request =
       ExportEvaluatedExamplesRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setOutputConfig(ExportEvaluatedExamplesOutputConfig.newBuilder().build())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.exportEvaluatedExamplesOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<ExportEvaluatedExamplesRequest,Empty,OperationMetadata>

exportModelAsync(ExportModelRequest request)

public final OperationFuture<Empty,OperationMetadata> exportModelAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportModelRequest request =
       ExportModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setOutputConfig(ModelExportOutputConfig.newBuilder().build())
           .build();
   autoMlClient.exportModelAsync(request).get();
 }
Parameter
Name Description
request ExportModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportModelAsync(ModelName name, ModelExportOutputConfig outputConfig)

public final OperationFuture<Empty,OperationMetadata> exportModelAsync(ModelName name, ModelExportOutputConfig outputConfig)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ModelExportOutputConfig outputConfig = ModelExportOutputConfig.newBuilder().build();
   autoMlClient.exportModelAsync(name, outputConfig).get();
 }
Parameters
Name Description
name ModelName

Required. The resource name of the model to export.
outputConfig ModelExportOutputConfig

Required. The desired output location and configuration.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportModelAsync(String name, ModelExportOutputConfig outputConfig)

public final OperationFuture<Empty,OperationMetadata> exportModelAsync(String name, ModelExportOutputConfig outputConfig)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   ModelExportOutputConfig outputConfig = ModelExportOutputConfig.newBuilder().build();
   autoMlClient.exportModelAsync(name, outputConfig).get();
 }
Parameters
Name Description
name String

Required. The resource name of the model to export.
outputConfig ModelExportOutputConfig

Required. The desired output location and configuration.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

exportModelCallable()

public final UnaryCallable<ExportModelRequest,Operation> exportModelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportModelRequest request =
       ExportModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setOutputConfig(ModelExportOutputConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future = autoMlClient.exportModelCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ExportModelRequest,Operation>

exportModelOperationCallable()

public final OperationCallable<ExportModelRequest,Empty,OperationMetadata> exportModelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ExportModelRequest request =
       ExportModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setOutputConfig(ModelExportOutputConfig.newBuilder().build())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.exportModelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<ExportModelRequest,Empty,OperationMetadata>

getAnnotationSpec(AnnotationSpecName name)

public final AnnotationSpec getAnnotationSpec(AnnotationSpecName name)

Gets an annotation spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   AnnotationSpecName name =
       AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]");
   AnnotationSpec response = autoMlClient.getAnnotationSpec(name);
 }
Parameter
Name Description
name AnnotationSpecName

Required. The resource name of the annotation spec to retrieve.
Returns
Type Description
AnnotationSpec

getAnnotationSpec(GetAnnotationSpecRequest request)

public final AnnotationSpec getAnnotationSpec(GetAnnotationSpecRequest request)

Gets an annotation spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetAnnotationSpecRequest request =
       GetAnnotationSpecRequest.newBuilder()
           .setName(
               AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]")
                   .toString())
           .build();
   AnnotationSpec response = autoMlClient.getAnnotationSpec(request);
 }
Parameter
Name Description
request GetAnnotationSpecRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnnotationSpec

getAnnotationSpec(String name)

public final AnnotationSpec getAnnotationSpec(String name)

Gets an annotation spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name =
       AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]")
           .toString();
   AnnotationSpec response = autoMlClient.getAnnotationSpec(name);
 }
Parameter
Name Description
name String

Required. The resource name of the annotation spec to retrieve.
Returns
Type Description
AnnotationSpec

getAnnotationSpecCallable()

public final UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec> getAnnotationSpecCallable()

Gets an annotation spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetAnnotationSpecRequest request =
       GetAnnotationSpecRequest.newBuilder()
           .setName(
               AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]")
                   .toString())
           .build();
   ApiFuture<AnnotationSpec> future =
       autoMlClient.getAnnotationSpecCallable().futureCall(request);
   // Do something.
   AnnotationSpec response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec>

getColumnSpec(ColumnSpecName name)

public final ColumnSpec getColumnSpec(ColumnSpecName name)

Gets a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ColumnSpecName name =
       ColumnSpecName.of(
           "[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]", "[COLUMN_SPEC]");
   ColumnSpec response = autoMlClient.getColumnSpec(name);
 }
Parameter
Name Description
name ColumnSpecName

Required. The resource name of the column spec to retrieve.
Returns
Type Description
ColumnSpec

getColumnSpec(GetColumnSpecRequest request)

public final ColumnSpec getColumnSpec(GetColumnSpecRequest request)

Gets a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetColumnSpecRequest request =
       GetColumnSpecRequest.newBuilder()
           .setName(
               ColumnSpecName.of(
                       "[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]", "[COLUMN_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .build();
   ColumnSpec response = autoMlClient.getColumnSpec(request);
 }
Parameter
Name Description
request GetColumnSpecRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ColumnSpec

getColumnSpec(String name)

public final ColumnSpec getColumnSpec(String name)

Gets a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name =
       ColumnSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]", "[COLUMN_SPEC]")
           .toString();
   ColumnSpec response = autoMlClient.getColumnSpec(name);
 }
Parameter
Name Description
name String

Required. The resource name of the column spec to retrieve.
Returns
Type Description
ColumnSpec

getColumnSpecCallable()

public final UnaryCallable<GetColumnSpecRequest,ColumnSpec> getColumnSpecCallable()

Gets a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetColumnSpecRequest request =
       GetColumnSpecRequest.newBuilder()
           .setName(
               ColumnSpecName.of(
                       "[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]", "[COLUMN_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ColumnSpec> future = autoMlClient.getColumnSpecCallable().futureCall(request);
   // Do something.
   ColumnSpec response = future.get();
 }
Returns
Type Description
UnaryCallable<GetColumnSpecRequest,ColumnSpec>

getDataset(DatasetName name)

public final Dataset getDataset(DatasetName name)

Gets a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Dataset response = autoMlClient.getDataset(name);
 }
Parameter
Name Description
name DatasetName

Required. The resource name of the dataset to retrieve.
Returns
Type Description
Dataset

getDataset(GetDatasetRequest request)

public final Dataset getDataset(GetDatasetRequest request)

Gets a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetDatasetRequest request =
       GetDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   Dataset response = autoMlClient.getDataset(request);
 }
Parameter
Name Description
request GetDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Dataset

getDataset(String name)

public final Dataset getDataset(String name)

Gets a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   Dataset response = autoMlClient.getDataset(name);
 }
Parameter
Name Description
name String

Required. The resource name of the dataset to retrieve.
Returns
Type Description
Dataset

getDatasetCallable()

public final UnaryCallable<GetDatasetRequest,Dataset> getDatasetCallable()

Gets a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetDatasetRequest request =
       GetDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   ApiFuture<Dataset> future = autoMlClient.getDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDatasetRequest,Dataset>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getModel(GetModelRequest request)

public final Model getModel(GetModelRequest request)

Gets a model.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetModelRequest request =
       GetModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   Model response = autoMlClient.getModel(request);
 }
Parameter
Name Description
request GetModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Model

getModel(ModelName name)

public final Model getModel(ModelName name)

Gets a model.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Model response = autoMlClient.getModel(name);
 }
Parameter
Name Description
name ModelName

Required. Resource name of the model.
Returns
Type Description
Model

getModel(String name)

public final Model getModel(String name)

Gets a model.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   Model response = autoMlClient.getModel(name);
 }
Parameter
Name Description
name String

Required. Resource name of the model.
Returns
Type Description
Model

getModelCallable()

public final UnaryCallable<GetModelRequest,Model> getModelCallable()

Gets a model.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetModelRequest request =
       GetModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   ApiFuture<Model> future = autoMlClient.getModelCallable().futureCall(request);
   // Do something.
   Model response = future.get();
 }
Returns
Type Description
UnaryCallable<GetModelRequest,Model>

getModelEvaluation(GetModelEvaluationRequest request)

public final ModelEvaluation getModelEvaluation(GetModelEvaluationRequest request)

Gets a model evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetModelEvaluationRequest request =
       GetModelEvaluationRequest.newBuilder()
           .setName(
               ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]")
                   .toString())
           .build();
   ModelEvaluation response = autoMlClient.getModelEvaluation(request);
 }
Parameter
Name Description
request GetModelEvaluationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ModelEvaluation

getModelEvaluation(ModelEvaluationName name)

public final ModelEvaluation getModelEvaluation(ModelEvaluationName name)

Gets a model evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelEvaluationName name =
       ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]");
   ModelEvaluation response = autoMlClient.getModelEvaluation(name);
 }
Parameter
Name Description
name ModelEvaluationName

Required. Resource name for the model evaluation.
Returns
Type Description
ModelEvaluation

getModelEvaluation(String name)

public final ModelEvaluation getModelEvaluation(String name)

Gets a model evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name =
       ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]")
           .toString();
   ModelEvaluation response = autoMlClient.getModelEvaluation(name);
 }
Parameter
Name Description
name String

Required. Resource name for the model evaluation.
Returns
Type Description
ModelEvaluation

getModelEvaluationCallable()

public final UnaryCallable<GetModelEvaluationRequest,ModelEvaluation> getModelEvaluationCallable()

Gets a model evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetModelEvaluationRequest request =
       GetModelEvaluationRequest.newBuilder()
           .setName(
               ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]")
                   .toString())
           .build();
   ApiFuture<ModelEvaluation> future =
       autoMlClient.getModelEvaluationCallable().futureCall(request);
   // Do something.
   ModelEvaluation response = future.get();
 }
Returns
Type Description
UnaryCallable<GetModelEvaluationRequest,ModelEvaluation>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final AutoMlSettings getSettings()
Returns
Type Description
AutoMlSettings

getStub()

public AutoMlStub getStub()
Returns
Type Description
AutoMlStub

getTableSpec(GetTableSpecRequest request)

public final TableSpec getTableSpec(GetTableSpecRequest request)

Gets a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetTableSpecRequest request =
       GetTableSpecRequest.newBuilder()
           .setName(
               TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .build();
   TableSpec response = autoMlClient.getTableSpec(request);
 }
Parameter
Name Description
request GetTableSpecRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TableSpec

getTableSpec(TableSpecName name)

public final TableSpec getTableSpec(TableSpecName name)

Gets a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   TableSpecName name = TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]");
   TableSpec response = autoMlClient.getTableSpec(name);
 }
Parameter
Name Description
name TableSpecName

Required. The resource name of the table spec to retrieve.
Returns
Type Description
TableSpec

getTableSpec(String name)

public final TableSpec getTableSpec(String name)

Gets a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name =
       TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]").toString();
   TableSpec response = autoMlClient.getTableSpec(name);
 }
Parameter
Name Description
name String

Required. The resource name of the table spec to retrieve.
Returns
Type Description
TableSpec

getTableSpecCallable()

public final UnaryCallable<GetTableSpecRequest,TableSpec> getTableSpecCallable()

Gets a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   GetTableSpecRequest request =
       GetTableSpecRequest.newBuilder()
           .setName(
               TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<TableSpec> future = autoMlClient.getTableSpecCallable().futureCall(request);
   // Do something.
   TableSpec response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTableSpecRequest,TableSpec>

importDataAsync(DatasetName name, InputConfig inputConfig)

public final OperationFuture<Empty,OperationMetadata> importDataAsync(DatasetName name, InputConfig inputConfig)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   autoMlClient.importDataAsync(name, inputConfig).get();
 }
Parameters
Name Description
name DatasetName

Required. Dataset name. Dataset must already exist. All imported annotations and examples will be added.
inputConfig InputConfig

Required. The desired input location and its domain specific semantics, if any.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

importDataAsync(ImportDataRequest request)

public final OperationFuture<Empty,OperationMetadata> importDataAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setInputConfig(InputConfig.newBuilder().build())
           .build();
   autoMlClient.importDataAsync(request).get();
 }
Parameter
Name Description
request ImportDataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

importDataAsync(String name, InputConfig inputConfig)

public final OperationFuture<Empty,OperationMetadata> importDataAsync(String name, InputConfig inputConfig)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   InputConfig inputConfig = InputConfig.newBuilder().build();
   autoMlClient.importDataAsync(name, inputConfig).get();
 }
Parameters
Name Description
name String

Required. Dataset name. Dataset must already exist. All imported annotations and examples will be added.
inputConfig InputConfig

Required. The desired input location and its domain specific semantics, if any.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

importDataCallable()

public final UnaryCallable<ImportDataRequest,Operation> importDataCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setInputConfig(InputConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future = autoMlClient.importDataCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ImportDataRequest,Operation>

importDataOperationCallable()

public final OperationCallable<ImportDataRequest,Empty,OperationMetadata> importDataOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setInputConfig(InputConfig.newBuilder().build())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.importDataOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<ImportDataRequest,Empty,OperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listColumnSpecs(ListColumnSpecsRequest request)

public final AutoMlClient.ListColumnSpecsPagedResponse listColumnSpecs(ListColumnSpecsRequest request)

Lists column specs in a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListColumnSpecsRequest request =
       ListColumnSpecsRequest.newBuilder()
           .setParent(
               TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ColumnSpec element : autoMlClient.listColumnSpecs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListColumnSpecsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutoMlClient.ListColumnSpecsPagedResponse

listColumnSpecs(TableSpecName parent)

public final AutoMlClient.ListColumnSpecsPagedResponse listColumnSpecs(TableSpecName parent)

Lists column specs in a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   TableSpecName parent =
       TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]");
   for (ColumnSpec element : autoMlClient.listColumnSpecs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent TableSpecName

Required. The resource name of the table spec to list column specs from.
Returns
Type Description
AutoMlClient.ListColumnSpecsPagedResponse

listColumnSpecs(String parent)

public final AutoMlClient.ListColumnSpecsPagedResponse listColumnSpecs(String parent)

Lists column specs in a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent =
       TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]").toString();
   for (ColumnSpec element : autoMlClient.listColumnSpecs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the table spec to list column specs from.
Returns
Type Description
AutoMlClient.ListColumnSpecsPagedResponse

listColumnSpecsCallable()

public final UnaryCallable<ListColumnSpecsRequest,ListColumnSpecsResponse> listColumnSpecsCallable()

Lists column specs in a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListColumnSpecsRequest request =
       ListColumnSpecsRequest.newBuilder()
           .setParent(
               TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListColumnSpecsResponse response = autoMlClient.listColumnSpecsCallable().call(request);
     for (ColumnSpec element : response.getColumnSpecsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListColumnSpecsRequest,ListColumnSpecsResponse>

listColumnSpecsPagedCallable()

public final UnaryCallable<ListColumnSpecsRequest,AutoMlClient.ListColumnSpecsPagedResponse> listColumnSpecsPagedCallable()

Lists column specs in a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListColumnSpecsRequest request =
       ListColumnSpecsRequest.newBuilder()
           .setParent(
               TableSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[TABLE_SPEC]")
                   .toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ColumnSpec> future =
       autoMlClient.listColumnSpecsPagedCallable().futureCall(request);
   // Do something.
   for (ColumnSpec element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListColumnSpecsRequest,ListColumnSpecsPagedResponse>

listDatasets(ListDatasetsRequest request)

public final AutoMlClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)

Lists datasets in a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Dataset element : autoMlClient.listDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDatasetsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutoMlClient.ListDatasetsPagedResponse

listDatasets(LocationName parent)

public final AutoMlClient.ListDatasetsPagedResponse listDatasets(LocationName parent)

Lists datasets in a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Dataset element : autoMlClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The resource name of the project from which to list datasets.
Returns
Type Description
AutoMlClient.ListDatasetsPagedResponse

listDatasets(String parent)

public final AutoMlClient.ListDatasetsPagedResponse listDatasets(String parent)

Lists datasets in a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Dataset element : autoMlClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the project from which to list datasets.
Returns
Type Description
AutoMlClient.ListDatasetsPagedResponse

listDatasetsCallable()

public final UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> listDatasetsCallable()

Lists datasets in a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDatasetsResponse response = autoMlClient.listDatasetsCallable().call(request);
     for (Dataset element : response.getDatasetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>

listDatasetsPagedCallable()

public final UnaryCallable<ListDatasetsRequest,AutoMlClient.ListDatasetsPagedResponse> listDatasetsPagedCallable()

Lists datasets in a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Dataset> future = autoMlClient.listDatasetsPagedCallable().futureCall(request);
   // Do something.
   for (Dataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDatasetsRequest,ListDatasetsPagedResponse>

listModelEvaluations(ListModelEvaluationsRequest request)

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(ListModelEvaluationsRequest request)

Lists model evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListModelEvaluationsRequest request =
       ListModelEvaluationsRequest.newBuilder()
           .setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ModelEvaluation element : autoMlClient.listModelEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListModelEvaluationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutoMlClient.ListModelEvaluationsPagedResponse

listModelEvaluations(ModelName parent)

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(ModelName parent)

Lists model evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   for (ModelEvaluation element : autoMlClient.listModelEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ModelName

Required. Resource name of the model to list the model evaluations for. If modelId is set as "-", this will list model evaluations from across all models of the parent location.
Returns
Type Description
AutoMlClient.ListModelEvaluationsPagedResponse

listModelEvaluations(String parent)

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(String parent)

Lists model evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   for (ModelEvaluation element : autoMlClient.listModelEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Resource name of the model to list the model evaluations for. If modelId is set as "-", this will list model evaluations from across all models of the parent location.
Returns
Type Description
AutoMlClient.ListModelEvaluationsPagedResponse

listModelEvaluationsCallable()

public final UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsResponse> listModelEvaluationsCallable()

Lists model evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListModelEvaluationsRequest request =
       ListModelEvaluationsRequest.newBuilder()
           .setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListModelEvaluationsResponse response =
         autoMlClient.listModelEvaluationsCallable().call(request);
     for (ModelEvaluation element : response.getModelEvaluationList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsResponse>

listModelEvaluationsPagedCallable()

public final UnaryCallable<ListModelEvaluationsRequest,AutoMlClient.ListModelEvaluationsPagedResponse> listModelEvaluationsPagedCallable()

Lists model evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListModelEvaluationsRequest request =
       ListModelEvaluationsRequest.newBuilder()
           .setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ModelEvaluation> future =
       autoMlClient.listModelEvaluationsPagedCallable().futureCall(request);
   // Do something.
   for (ModelEvaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsPagedResponse>

listModels(ListModelsRequest request)

public final AutoMlClient.ListModelsPagedResponse listModels(ListModelsRequest request)

Lists models.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Model element : autoMlClient.listModels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListModelsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutoMlClient.ListModelsPagedResponse

listModels(LocationName parent)

public final AutoMlClient.ListModelsPagedResponse listModels(LocationName parent)

Lists models.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Model element : autoMlClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Resource name of the project, from which to list the models.
Returns
Type Description
AutoMlClient.ListModelsPagedResponse

listModels(String parent)

public final AutoMlClient.ListModelsPagedResponse listModels(String parent)

Lists models.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Model element : autoMlClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Resource name of the project, from which to list the models.
Returns
Type Description
AutoMlClient.ListModelsPagedResponse

listModelsCallable()

public final UnaryCallable<ListModelsRequest,ListModelsResponse> listModelsCallable()

Lists models.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListModelsResponse response = autoMlClient.listModelsCallable().call(request);
     for (Model element : response.getModelList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListModelsRequest,ListModelsResponse>

listModelsPagedCallable()

public final UnaryCallable<ListModelsRequest,AutoMlClient.ListModelsPagedResponse> listModelsPagedCallable()

Lists models.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Model> future = autoMlClient.listModelsPagedCallable().futureCall(request);
   // Do something.
   for (Model element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListModelsRequest,ListModelsPagedResponse>

listTableSpecs(DatasetName parent)

public final AutoMlClient.ListTableSpecsPagedResponse listTableSpecs(DatasetName parent)

Lists table specs in a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   for (TableSpec element : autoMlClient.listTableSpecs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent DatasetName

Required. The resource name of the dataset to list table specs from.
Returns
Type Description
AutoMlClient.ListTableSpecsPagedResponse

listTableSpecs(ListTableSpecsRequest request)

public final AutoMlClient.ListTableSpecsPagedResponse listTableSpecs(ListTableSpecsRequest request)

Lists table specs in a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListTableSpecsRequest request =
       ListTableSpecsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TableSpec element : autoMlClient.listTableSpecs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListTableSpecsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AutoMlClient.ListTableSpecsPagedResponse

listTableSpecs(String parent)

public final AutoMlClient.ListTableSpecsPagedResponse listTableSpecs(String parent)

Lists table specs in a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   for (TableSpec element : autoMlClient.listTableSpecs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The resource name of the dataset to list table specs from.
Returns
Type Description
AutoMlClient.ListTableSpecsPagedResponse

listTableSpecsCallable()

public final UnaryCallable<ListTableSpecsRequest,ListTableSpecsResponse> listTableSpecsCallable()

Lists table specs in a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListTableSpecsRequest request =
       ListTableSpecsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTableSpecsResponse response = autoMlClient.listTableSpecsCallable().call(request);
     for (TableSpec element : response.getTableSpecsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListTableSpecsRequest,ListTableSpecsResponse>

listTableSpecsPagedCallable()

public final UnaryCallable<ListTableSpecsRequest,AutoMlClient.ListTableSpecsPagedResponse> listTableSpecsPagedCallable()

Lists table specs in a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ListTableSpecsRequest request =
       ListTableSpecsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setFieldMask(FieldMask.newBuilder().build())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TableSpec> future = autoMlClient.listTableSpecsPagedCallable().futureCall(request);
   // Do something.
   for (TableSpec element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListTableSpecsRequest,ListTableSpecsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeployModelAsync(ModelName name)

public final OperationFuture<Empty,OperationMetadata> undeployModelAsync(ModelName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   autoMlClient.undeployModelAsync(name).get();
 }
Parameter
Name Description
name ModelName

Required. Resource name of the model to undeploy.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

undeployModelAsync(UndeployModelRequest request)

public final OperationFuture<Empty,OperationMetadata> undeployModelAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UndeployModelRequest request =
       UndeployModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   autoMlClient.undeployModelAsync(request).get();
 }
Parameter
Name Description
request UndeployModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

undeployModelAsync(String name)

public final OperationFuture<Empty,OperationMetadata> undeployModelAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   autoMlClient.undeployModelAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name of the model to undeploy.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

undeployModelCallable()

public final UnaryCallable<UndeployModelRequest,Operation> undeployModelCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UndeployModelRequest request =
       UndeployModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   ApiFuture<Operation> future = autoMlClient.undeployModelCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<UndeployModelRequest,Operation>

undeployModelOperationCallable()

public final OperationCallable<UndeployModelRequest,Empty,OperationMetadata> undeployModelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UndeployModelRequest request =
       UndeployModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       autoMlClient.undeployModelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<UndeployModelRequest,Empty,OperationMetadata>

updateColumnSpec(ColumnSpec columnSpec)

public final ColumnSpec updateColumnSpec(ColumnSpec columnSpec)

Updates a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ColumnSpec columnSpec = ColumnSpec.newBuilder().build();
   ColumnSpec response = autoMlClient.updateColumnSpec(columnSpec);
 }
Parameter
Name Description
columnSpec ColumnSpec

Required. The column spec which replaces the resource on the server.
Returns
Type Description
ColumnSpec

updateColumnSpec(UpdateColumnSpecRequest request)

public final ColumnSpec updateColumnSpec(UpdateColumnSpecRequest request)

Updates a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UpdateColumnSpecRequest request =
       UpdateColumnSpecRequest.newBuilder()
           .setColumnSpec(ColumnSpec.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ColumnSpec response = autoMlClient.updateColumnSpec(request);
 }
Parameter
Name Description
request UpdateColumnSpecRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ColumnSpec

updateColumnSpecCallable()

public final UnaryCallable<UpdateColumnSpecRequest,ColumnSpec> updateColumnSpecCallable()

Updates a column spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UpdateColumnSpecRequest request =
       UpdateColumnSpecRequest.newBuilder()
           .setColumnSpec(ColumnSpec.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ColumnSpec> future = autoMlClient.updateColumnSpecCallable().futureCall(request);
   // Do something.
   ColumnSpec response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateColumnSpecRequest,ColumnSpec>

updateDataset(Dataset dataset)

public final Dataset updateDataset(Dataset dataset)

Updates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.updateDataset(dataset);
 }
Parameter
Name Description
dataset Dataset

Required. The dataset which replaces the resource on the server.
Returns
Type Description
Dataset

updateDataset(UpdateDatasetRequest request)

public final Dataset updateDataset(UpdateDatasetRequest request)

Updates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Dataset response = autoMlClient.updateDataset(request);
 }
Parameter
Name Description
request UpdateDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Dataset

updateDatasetCallable()

public final UnaryCallable<UpdateDatasetRequest,Dataset> updateDatasetCallable()

Updates a dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Dataset> future = autoMlClient.updateDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateDatasetRequest,Dataset>

updateTableSpec(TableSpec tableSpec)

public final TableSpec updateTableSpec(TableSpec tableSpec)

Updates a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   TableSpec tableSpec = TableSpec.newBuilder().build();
   TableSpec response = autoMlClient.updateTableSpec(tableSpec);
 }
Parameter
Name Description
tableSpec TableSpec

Required. The table spec which replaces the resource on the server.
Returns
Type Description
TableSpec

updateTableSpec(UpdateTableSpecRequest request)

public final TableSpec updateTableSpec(UpdateTableSpecRequest request)

Updates a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UpdateTableSpecRequest request =
       UpdateTableSpecRequest.newBuilder()
           .setTableSpec(TableSpec.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   TableSpec response = autoMlClient.updateTableSpec(request);
 }
Parameter
Name Description
request UpdateTableSpecRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TableSpec

updateTableSpecCallable()

public final UnaryCallable<UpdateTableSpecRequest,TableSpec> updateTableSpecCallable()

Updates a table spec.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   UpdateTableSpecRequest request =
       UpdateTableSpecRequest.newBuilder()
           .setTableSpec(TableSpec.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<TableSpec> future = autoMlClient.updateTableSpecCallable().futureCall(request);
   // Do something.
   TableSpec response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateTableSpecRequest,TableSpec>