Class AutoMlClient (2.28.0)

public class AutoMlClient implements BackgroundResource

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 dash-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()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Dataset response = autoMlClient.getDataset(name);
 }
 

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().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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

Implements

BackgroundResource

Static Methods

create()

public static final AutoMlClient create()

Constructs an instance of AutoMlClient with default settings.

Returns
TypeDescription
AutoMlClient
Exceptions
TypeDescription
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
NameDescription
settingsAutoMlSettings
Returns
TypeDescription
AutoMlClient
Exceptions
TypeDescription
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
NameDescription
stubAutoMlStub
Returns
TypeDescription
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
NameDescription
settingsAutoMlSettings

AutoMlClient(AutoMlStub stub)

protected AutoMlClient(AutoMlStub stub)
Parameter
NameDescription
stubAutoMlStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createDatasetAsync(CreateDatasetRequest request)

public final OperationFuture<Dataset,OperationMetadata> createDatasetAsync(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.createDatasetAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateDatasetRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Dataset,OperationMetadata>

createDatasetAsync(LocationName parent, Dataset dataset)

public final OperationFuture<Dataset,OperationMetadata> createDatasetAsync(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.createDatasetAsync(parent, dataset).get();
 }
 
Parameters
NameDescription
parentLocationName

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

datasetDataset

Required. The dataset to create.

Returns
TypeDescription
OperationFuture<Dataset,OperationMetadata>

createDatasetAsync(String parent, Dataset dataset)

public final OperationFuture<Dataset,OperationMetadata> createDatasetAsync(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.createDatasetAsync(parent, dataset).get();
 }
 
Parameters
NameDescription
parentString

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

datasetDataset

Required. The dataset to create.

Returns
TypeDescription
OperationFuture<Dataset,OperationMetadata>

createDatasetCallable()

public final UnaryCallable<CreateDatasetRequest,Operation> 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<Operation> future = autoMlClient.createDatasetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateDatasetRequest,Operation>

createDatasetOperationCallable()

public final OperationCallable<CreateDatasetRequest,Dataset,OperationMetadata> createDatasetOperationCallable()

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();
   OperationFuture<Dataset, OperationMetadata> future =
       autoMlClient.createDatasetOperationCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateDatasetRequest,Dataset,OperationMetadata>

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
NameDescription
requestCreateModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
parentLocationName

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

modelModel

Required. The model to create.

Returns
TypeDescription
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
NameDescription
parentString

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

modelModel

Required. The model to create.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
nameDatasetName

Required. The resource name of the dataset to delete.

Returns
TypeDescription
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
NameDescription
requestDeleteDatasetRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameString

Required. The resource name of the dataset to delete.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestDeleteModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameModelName

Required. Resource name of the model being deleted.

Returns
TypeDescription
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
NameDescription
nameString

Required. Resource name of the model being deleted.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestDeployModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameModelName

Required. Resource name of the model to deploy.

Returns
TypeDescription
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
NameDescription
nameString

Required. Resource name of the model to deploy.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
nameDatasetName

Required. The resource name of the dataset.

outputConfigOutputConfig

Required. The desired output location.

Returns
TypeDescription
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
NameDescription
requestExportDataRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameString

Required. The resource name of the dataset.

outputConfigOutputConfig

Required. The desired output location.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<ExportDataRequest,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
NameDescription
requestExportModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameModelName

Required. The resource name of the model to export.

outputConfigModelExportOutputConfig

Required. The desired output location and configuration.

Returns
TypeDescription
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
NameDescription
nameString

Required. The resource name of the model to export.

outputConfigModelExportOutputConfig

Required. The desired output location and configuration.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
nameAnnotationSpecName

Required. The resource name of the annotation spec to retrieve.

Returns
TypeDescription
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
NameDescription
requestGetAnnotationSpecRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameString

Required. The resource name of the annotation spec to retrieve.

Returns
TypeDescription
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
TypeDescription
UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec>

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
NameDescription
nameDatasetName

Required. The resource name of the dataset to retrieve.

Returns
TypeDescription
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
NameDescription
requestGetDatasetRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameString

Required. The resource name of the dataset to retrieve.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestGetModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameModelName

Required. Resource name of the model.

Returns
TypeDescription
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
NameDescription
nameString

Required. Resource name of the model.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestGetModelEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameModelEvaluationName

Required. Resource name for the model evaluation.

Returns
TypeDescription
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
NameDescription
nameString

Required. Resource name for the model evaluation.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OperationsClient

getSettings()

public final AutoMlSettings getSettings()
Returns
TypeDescription
AutoMlSettings

getStub()

public AutoMlStub getStub()
Returns
TypeDescription
AutoMlStub

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
NameDescription
nameDatasetName

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

inputConfigInputConfig

Required. The desired input location and its domain specific semantics, if any.

Returns
TypeDescription
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
NameDescription
requestImportDataRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameString

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

inputConfigInputConfig

Required. The desired input location and its domain specific semantics, if any.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<ImportDataRequest,Empty,OperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

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
NameDescription
requestListDatasetsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
parentLocationName

Required. The resource name of the project from which to list datasets.

Returns
TypeDescription
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
NameDescription
parentString

Required. The resource name of the project from which to list datasets.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestListModelEvaluationsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AutoMlClient.ListModelEvaluationsPagedResponse

listModelEvaluations(ModelName parent, String filter)

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(ModelName parent, String filter)

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]");
   String filter = "filter-1274492040";
   for (ModelEvaluation element :
       autoMlClient.listModelEvaluations(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
parentModelName

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.

filterString

Required. An expression for filtering the results of the request.

* annotation_spec_id - for =, != or existence. See example below for the last.

Some examples of using the filter are:

* annotation_spec_id!=4 --> The model evaluation was done for annotation spec with ID different than 4. * NOT annotation_spec_id:* --> The model evaluation was done for aggregate of all annotation specs.

Returns
TypeDescription
AutoMlClient.ListModelEvaluationsPagedResponse

listModelEvaluations(String parent, String filter)

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(String parent, String filter)

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();
   String filter = "filter-1274492040";
   for (ModelEvaluation element :
       autoMlClient.listModelEvaluations(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameters
NameDescription
parentString

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.

filterString

Required. An expression for filtering the results of the request.

* annotation_spec_id - for =, != or existence. See example below for the last.

Some examples of using the filter are:

* annotation_spec_id!=4 --> The model evaluation was done for annotation spec with ID different than 4. * NOT annotation_spec_id:* --> The model evaluation was done for aggregate of all annotation specs.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestListModelsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
parentLocationName

Required. Resource name of the project, from which to list the models.

Returns
TypeDescription
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
NameDescription
parentString

Required. Resource name of the project, from which to list the models.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListModelsRequest,ListModelsPagedResponse>

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
NameDescription
nameModelName

Required. Resource name of the model to undeploy.

Returns
TypeDescription
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
NameDescription
requestUndeployModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
nameString

Required. Resource name of the model to undeploy.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<UndeployModelRequest,Empty,OperationMetadata>

updateDataset(Dataset dataset, FieldMask updateMask)

public final Dataset updateDataset(Dataset dataset, FieldMask updateMask)

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();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Dataset response = autoMlClient.updateDataset(dataset, updateMask);
 }
 
Parameters
NameDescription
datasetDataset

Required. The dataset which replaces the resource on the server.

updateMaskFieldMask

Required. The update mask applies to the resource.

Returns
TypeDescription
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
NameDescription
requestUpdateDatasetRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
TypeDescription
UnaryCallable<UpdateDatasetRequest,Dataset>

updateModel(Model model, FieldMask updateMask)

public final Model updateModel(Model model, FieldMask updateMask)

Updates 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()) {
   Model model = Model.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Model response = autoMlClient.updateModel(model, updateMask);
 }
 
Parameters
NameDescription
modelModel

Required. The model which replaces the resource on the server.

updateMaskFieldMask

Required. The update mask applies to the resource.

Returns
TypeDescription
Model

updateModel(UpdateModelRequest request)

public final Model updateModel(UpdateModelRequest request)

Updates 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()) {
   UpdateModelRequest request =
       UpdateModelRequest.newBuilder()
           .setModel(Model.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Model response = autoMlClient.updateModel(request);
 }
 
Parameter
NameDescription
requestUpdateModelRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Model

updateModelCallable()

public final UnaryCallable<UpdateModelRequest,Model> updateModelCallable()

Updates 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()) {
   UpdateModelRequest request =
       UpdateModelRequest.newBuilder()
           .setModel(Model.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Model> future = autoMlClient.updateModelCallable().futureCall(request);
   // Do something.
   Model response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateModelRequest,Model>