com.google.cloud.automl.v1beta1

Class AutoMlClient

java.lang.Object

com.google.cloud.automl.v1beta1.AutoMlClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class AutoMlClient
extends Object
implements com.google.api.gax.core.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}`.

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:

 
 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.createDataset(parent, dataset);
 }
 
 

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

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:

 
 AutoMlSettings autoMlSettings =
     AutoMlSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AutoMlClient autoMlClient =
     AutoMlClient.create(autoMlSettings);
 
 

To customize the endpoint:

 
 AutoMlSettings autoMlSettings =
     AutoMlSettings.newBuilder().setEndpoint(myEndpoint).build();
 AutoMlClient autoMlClient =
     AutoMlClient.create(autoMlSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoMlClient.ListDatasetsFixedSizeCollection
static class	AutoMlClient.ListDatasetsPage
static class	AutoMlClient.ListDatasetsPagedResponse
static class	AutoMlClient.ListModelEvaluationsFixedSizeCollection
static class	AutoMlClient.ListModelEvaluationsPage
static class	AutoMlClient.ListModelEvaluationsPagedResponse
static class	AutoMlClient.ListModelsFixedSizeCollection
static class	AutoMlClient.ListModelsPage
static class	AutoMlClient.ListModelsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AutoMlClient(AutoMlSettings settings) Constructs an instance of AutoMlClient, using the given settings.
protected	AutoMlClient(AutoMlStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static AutoMlClient	create() Constructs an instance of AutoMlClient with default settings.
static AutoMlClient	create(AutoMlSettings settings) Constructs an instance of AutoMlClient, using the given settings.
static AutoMlClient	create(AutoMlStub stub) Constructs an instance of AutoMlClient, using the given stub for making calls.
Dataset	createDataset(CreateDatasetRequest request) Creates a dataset.
Dataset	createDataset(LocationName parent, Dataset dataset) Creates a dataset.
Dataset	createDataset(String parent, Dataset dataset) Creates a dataset.
com.google.api.gax.rpc.UnaryCallable<CreateDatasetRequest,Dataset>	createDatasetCallable() Creates a dataset.
com.google.api.gax.longrunning.OperationFuture<Model,OperationMetadata>	createModelAsync(CreateModelRequest request) Creates a model.
com.google.api.gax.longrunning.OperationFuture<Model,OperationMetadata>	createModelAsync(LocationName parent, Model model) Creates a model.
com.google.api.gax.longrunning.OperationFuture<Model,OperationMetadata>	createModelAsync(String parent, Model model) Creates a model.
com.google.api.gax.rpc.UnaryCallable<CreateModelRequest,com.google.longrunning.Operation>	createModelCallable() Creates a model.
com.google.api.gax.rpc.OperationCallable<CreateModelRequest,Model,OperationMetadata>	createModelOperationCallable() Creates a model.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteDatasetAsync(DatasetName name) Deletes a dataset and all of its contents.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteDatasetAsync(DeleteDatasetRequest request) Deletes a dataset and all of its contents.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteDatasetAsync(String name) Deletes a dataset and all of its contents.
com.google.api.gax.rpc.UnaryCallable<DeleteDatasetRequest,com.google.longrunning.Operation>	deleteDatasetCallable() Deletes a dataset and all of its contents.
com.google.api.gax.rpc.OperationCallable<DeleteDatasetRequest,com.google.protobuf.Empty,OperationMetadata>	deleteDatasetOperationCallable() Deletes a dataset and all of its contents.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteModelAsync(DeleteModelRequest request) Deletes a model.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteModelAsync(ModelName name) Deletes a model.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteModelAsync(String name) Deletes a model.
com.google.api.gax.rpc.UnaryCallable<DeleteModelRequest,com.google.longrunning.Operation>	deleteModelCallable() Deletes a model.
com.google.api.gax.rpc.OperationCallable<DeleteModelRequest,com.google.protobuf.Empty,OperationMetadata>	deleteModelOperationCallable() Deletes a model.
com.google.longrunning.Operation	deployModel(DeployModelRequest request) Deploys model.
com.google.longrunning.Operation	deployModel(ModelName name) Deploys model.
com.google.longrunning.Operation	deployModel(String name) Deploys model.
com.google.api.gax.rpc.UnaryCallable<DeployModelRequest,com.google.longrunning.Operation>	deployModelCallable() Deploys model.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	exportDataAsync(DatasetName name, OutputConfig outputConfig) Exports dataset's data to a Google Cloud Storage bucket.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	exportDataAsync(ExportDataRequest request) Exports dataset's data to a Google Cloud Storage bucket.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	exportDataAsync(String name, OutputConfig outputConfig) Exports dataset's data to a Google Cloud Storage bucket.
com.google.api.gax.rpc.UnaryCallable<ExportDataRequest,com.google.longrunning.Operation>	exportDataCallable() Exports dataset's data to a Google Cloud Storage bucket.
com.google.api.gax.rpc.OperationCallable<ExportDataRequest,com.google.protobuf.Empty,OperationMetadata>	exportDataOperationCallable() Exports dataset's data to a Google Cloud Storage bucket.
Dataset	getDataset(DatasetName name) Gets a dataset.
Dataset	getDataset(GetDatasetRequest request) Gets a dataset.
Dataset	getDataset(String name) Gets a dataset.
com.google.api.gax.rpc.UnaryCallable<GetDatasetRequest,Dataset>	getDatasetCallable() Gets a dataset.
Model	getModel(GetModelRequest request) Gets a model.
Model	getModel(ModelName name) Gets a model.
Model	getModel(String name) Gets a model.
com.google.api.gax.rpc.UnaryCallable<GetModelRequest,Model>	getModelCallable() Gets a model.
ModelEvaluation	getModelEvaluation(GetModelEvaluationRequest request) Gets a model evaluation.
ModelEvaluation	getModelEvaluation(ModelEvaluationName name) Gets a model evaluation.
ModelEvaluation	getModelEvaluation(String name) Gets a model evaluation.
com.google.api.gax.rpc.UnaryCallable<GetModelEvaluationRequest,ModelEvaluation>	getModelEvaluationCallable() Gets a model evaluation.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
AutoMlSettings	getSettings()
AutoMlStub	getStub()
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	importDataAsync(DatasetName name, InputConfig inputConfig) Imports data into a dataset.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	importDataAsync(ImportDataRequest request) Imports data into a dataset.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	importDataAsync(String name, InputConfig inputConfig) Imports data into a dataset.
com.google.api.gax.rpc.UnaryCallable<ImportDataRequest,com.google.longrunning.Operation>	importDataCallable() Imports data into a dataset.
com.google.api.gax.rpc.OperationCallable<ImportDataRequest,com.google.protobuf.Empty,OperationMetadata>	importDataOperationCallable() Imports data into a dataset.
boolean	isShutdown()
boolean	isTerminated()
AutoMlClient.ListDatasetsPagedResponse	listDatasets(ListDatasetsRequest request) Lists datasets in a project.
AutoMlClient.ListDatasetsPagedResponse	listDatasets(LocationName parent) Lists datasets in a project.
AutoMlClient.ListDatasetsPagedResponse	listDatasets(String parent) Lists datasets in a project.
com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>	listDatasetsCallable() Lists datasets in a project.
com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,AutoMlClient.ListDatasetsPagedResponse>	listDatasetsPagedCallable() Lists datasets in a project.
AutoMlClient.ListModelEvaluationsPagedResponse	listModelEvaluations(ListModelEvaluationsRequest request) Lists model evaluations.
AutoMlClient.ListModelEvaluationsPagedResponse	listModelEvaluations(ModelName parent) Lists model evaluations.
AutoMlClient.ListModelEvaluationsPagedResponse	listModelEvaluations(String parent) Lists model evaluations.
com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsResponse>	listModelEvaluationsCallable() Lists model evaluations.
com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,AutoMlClient.ListModelEvaluationsPagedResponse>	listModelEvaluationsPagedCallable() Lists model evaluations.
AutoMlClient.ListModelsPagedResponse	listModels(ListModelsRequest request) Lists models.
AutoMlClient.ListModelsPagedResponse	listModels(LocationName parent) Lists models.
AutoMlClient.ListModelsPagedResponse	listModels(String parent) Lists models.
com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,ListModelsResponse>	listModelsCallable() Lists models.
com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,AutoMlClient.ListModelsPagedResponse>	listModelsPagedCallable() Lists models.
void	shutdown()
void	shutdownNow()
com.google.longrunning.Operation	undeployModel(ModelName name) Undeploys model.
com.google.longrunning.Operation	undeployModel(String name) Undeploys model.
com.google.longrunning.Operation	undeployModel(UndeployModelRequest request) Undeploys model.
com.google.api.gax.rpc.UnaryCallable<UndeployModelRequest,com.google.longrunning.Operation>	undeployModelCallable() Undeploys model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoMlClient

protected AutoMlClient(AutoMlSettings settings)
                throws IOException

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.

Throws:

IOException

AutoMlClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected AutoMlClient(AutoMlStub stub)

Method Detail

create

public static final AutoMlClient create()
                                 throws IOException

Constructs an instance of AutoMlClient with default settings.

Throws:

IOException

create

public static final AutoMlClient create(AutoMlSettings settings)
                                 throws IOException

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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use AutoMlSettings}.

getSettings

public final AutoMlSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public AutoMlStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.longrunning.OperationsClient getOperationsClient()

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

createDataset

public final Dataset createDataset(LocationName parent,
                                   Dataset dataset)

Creates a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.createDataset(parent, dataset);
 }
 

Parameters:

parent - The resource name of the project to create the dataset for.

dataset - The dataset to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataset

public final Dataset createDataset(String parent,
                                   Dataset dataset)

Creates a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = autoMlClient.createDataset(parent.toString(), dataset);
 }
 

Parameters:

parent - The resource name of the project to create the dataset for.

dataset - The dataset to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataset

public final Dataset createDataset(CreateDatasetRequest request)

Creates a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   CreateDatasetRequest request = CreateDatasetRequest.newBuilder()
     .setParent(parent.toString())
     .setDataset(dataset)
     .build();
   Dataset response = autoMlClient.createDataset(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDatasetRequest,Dataset> createDatasetCallable()

Creates a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   CreateDatasetRequest request = CreateDatasetRequest.newBuilder()
     .setParent(parent.toString())
     .setDataset(dataset)
     .build();
   ApiFuture<Dataset> future = autoMlClient.createDatasetCallable().futureCall(request);
   // Do something
   Dataset response = future.get();
 }
 

getDataset

public final Dataset getDataset(DatasetName name)

Gets a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Dataset response = autoMlClient.getDataset(name);
 }
 

Parameters:

name - The resource name of the dataset to retrieve.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataset

public final Dataset getDataset(String name)

Gets a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Dataset response = autoMlClient.getDataset(name.toString());
 }
 

Parameters:

name - The resource name of the dataset to retrieve.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataset

public final Dataset getDataset(GetDatasetRequest request)

Gets a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   GetDatasetRequest request = GetDatasetRequest.newBuilder()
     .setName(name.toString())
     .build();
   Dataset response = autoMlClient.getDataset(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDatasetRequest,Dataset> getDatasetCallable()

Gets a dataset.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   GetDatasetRequest request = GetDatasetRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Dataset> future = autoMlClient.getDatasetCallable().futureCall(request);
   // Do something
   Dataset response = future.get();
 }
 

listDatasets

public final AutoMlClient.ListDatasetsPagedResponse listDatasets(LocationName parent)

Lists datasets in a project.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Dataset element : autoMlClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDatasets

public final AutoMlClient.ListDatasetsPagedResponse listDatasets(String parent)

Lists datasets in a project.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Dataset element : autoMlClient.listDatasets(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDatasets

public final AutoMlClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)

Lists datasets in a project.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListDatasetsRequest request = ListDatasetsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Dataset element : autoMlClient.listDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDatasetsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,AutoMlClient.ListDatasetsPagedResponse> listDatasetsPagedCallable()

Lists datasets in a project.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListDatasetsRequest request = ListDatasetsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListDatasetsPagedResponse> future = autoMlClient.listDatasetsPagedCallable().futureCall(request);
   // Do something
   for (Dataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listDatasetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> listDatasetsCallable()

Lists datasets in a project.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListDatasetsRequest request = ListDatasetsRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

deleteDatasetAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteDatasetAsync(DatasetName name)

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

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Empty response = autoMlClient.deleteDatasetAsync(name).get();
 }
 

Parameters:

name - The resource name of the dataset to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDatasetAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteDatasetAsync(String name)

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

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Empty response = autoMlClient.deleteDatasetAsync(name.toString()).get();
 }
 

Parameters:

name - The resource name of the dataset to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDatasetAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteDatasetAsync(DeleteDatasetRequest request)

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

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder()
     .setName(name.toString())
     .build();
   Empty response = autoMlClient.deleteDatasetAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDatasetOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<DeleteDatasetRequest,com.google.protobuf.Empty,OperationMetadata> deleteDatasetOperationCallable()

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

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder()
     .setName(name.toString())
     .build();
   OperationFuture<Operation> future = autoMlClient.deleteDatasetOperationCallable().futureCall(request);
   // Do something
   Empty response = future.get();
 }
 

deleteDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDatasetRequest,com.google.longrunning.Operation> deleteDatasetCallable()

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

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = autoMlClient.deleteDatasetCallable().futureCall(request);
   // Do something
   future.get();
 }
 

importDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> importDataAsync(DatasetName name,
                                                                                                                                                                                                                                   InputConfig inputConfig)

Imports data into a dataset. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   Empty response = autoMlClient.importDataAsync(name, inputConfig).get();
 }
 

Parameters:

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

inputConfig - Required. The desired input location.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> importDataAsync(String name,
                                                                                                                                                                                                                                   InputConfig inputConfig)

Imports data into a dataset. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   Empty response = autoMlClient.importDataAsync(name.toString(), inputConfig).get();
 }
 

Parameters:

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

inputConfig - Required. The desired input location.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> importDataAsync(ImportDataRequest request)

Imports data into a dataset. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataRequest request = ImportDataRequest.newBuilder()
     .setName(name.toString())
     .setInputConfig(inputConfig)
     .build();
   Empty response = autoMlClient.importDataAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importDataOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<ImportDataRequest,com.google.protobuf.Empty,OperationMetadata> importDataOperationCallable()

Imports data into a dataset. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataRequest request = ImportDataRequest.newBuilder()
     .setName(name.toString())
     .setInputConfig(inputConfig)
     .build();
   OperationFuture<Operation> future = autoMlClient.importDataOperationCallable().futureCall(request);
   // Do something
   Empty response = future.get();
 }
 

importDataCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportDataRequest,com.google.longrunning.Operation> importDataCallable()

Imports data into a dataset. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataRequest request = ImportDataRequest.newBuilder()
     .setName(name.toString())
     .setInputConfig(inputConfig)
     .build();
   ApiFuture<Operation> future = autoMlClient.importDataCallable().futureCall(request);
   // Do something
   future.get();
 }
 

exportDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> exportDataAsync(DatasetName name,
                                                                                                                                                                                                                                   OutputConfig outputConfig)

Exports dataset's data to a Google Cloud Storage bucket. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   Empty response = autoMlClient.exportDataAsync(name, outputConfig).get();
 }
 

Parameters:

name - Required. The resource name of the dataset.

outputConfig - Required. The desired output location.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> exportDataAsync(String name,
                                                                                                                                                                                                                                   OutputConfig outputConfig)

Exports dataset's data to a Google Cloud Storage bucket. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   Empty response = autoMlClient.exportDataAsync(name.toString(), outputConfig).get();
 }
 

Parameters:

name - Required. The resource name of the dataset.

outputConfig - Required. The desired output location.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> exportDataAsync(ExportDataRequest request)

Exports dataset's data to a Google Cloud Storage bucket. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataRequest request = ExportDataRequest.newBuilder()
     .setName(name.toString())
     .setOutputConfig(outputConfig)
     .build();
   Empty response = autoMlClient.exportDataAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportDataOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<ExportDataRequest,com.google.protobuf.Empty,OperationMetadata> exportDataOperationCallable()

Exports dataset's data to a Google Cloud Storage bucket. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataRequest request = ExportDataRequest.newBuilder()
     .setName(name.toString())
     .setOutputConfig(outputConfig)
     .build();
   OperationFuture<Operation> future = autoMlClient.exportDataOperationCallable().futureCall(request);
   // Do something
   Empty response = future.get();
 }
 

exportDataCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportDataRequest,com.google.longrunning.Operation> exportDataCallable()

Exports dataset's data to a Google Cloud Storage bucket. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataRequest request = ExportDataRequest.newBuilder()
     .setName(name.toString())
     .setOutputConfig(outputConfig)
     .build();
   ApiFuture<Operation> future = autoMlClient.exportDataCallable().futureCall(request);
   // Do something
   future.get();
 }
 

createModelAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Model,OperationMetadata> createModelAsync(LocationName parent,
                                                                                                                                                                                                                Model model)

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   Model response = autoMlClient.createModelAsync(parent, model).get();
 }
 

Parameters:

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

model - The model to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createModelAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Model,OperationMetadata> createModelAsync(String parent,
                                                                                                                                                                                                                Model model)

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   Model response = autoMlClient.createModelAsync(parent.toString(), model).get();
 }
 

Parameters:

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

model - The model to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createModelAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Model,OperationMetadata> createModelAsync(CreateModelRequest request)

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   CreateModelRequest request = CreateModelRequest.newBuilder()
     .setParent(parent.toString())
     .setModel(model)
     .build();
   Model response = autoMlClient.createModelAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createModelOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<CreateModelRequest,Model,OperationMetadata> createModelOperationCallable()

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   CreateModelRequest request = CreateModelRequest.newBuilder()
     .setParent(parent.toString())
     .setModel(model)
     .build();
   OperationFuture<Operation> future = autoMlClient.createModelOperationCallable().futureCall(request);
   // Do something
   Model response = future.get();
 }
 

createModelCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateModelRequest,com.google.longrunning.Operation> createModelCallable()

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   CreateModelRequest request = CreateModelRequest.newBuilder()
     .setParent(parent.toString())
     .setModel(model)
     .build();
   ApiFuture<Operation> future = autoMlClient.createModelCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getModel

public final Model getModel(ModelName name)

Gets a model.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Model response = autoMlClient.getModel(name);
 }
 

Parameters:

name - Resource name of the model.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getModel

public final Model getModel(String name)

Gets a model.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Model response = autoMlClient.getModel(name.toString());
 }
 

Parameters:

name - Resource name of the model.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getModel

public final Model getModel(GetModelRequest request)

Gets a model.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   GetModelRequest request = GetModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   Model response = autoMlClient.getModel(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getModelCallable

public final com.google.api.gax.rpc.UnaryCallable<GetModelRequest,Model> getModelCallable()

Gets a model.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   GetModelRequest request = GetModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Model> future = autoMlClient.getModelCallable().futureCall(request);
   // Do something
   Model response = future.get();
 }
 

listModels

public final AutoMlClient.ListModelsPagedResponse listModels(LocationName parent)

Lists models.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Model element : autoMlClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listModels

public final AutoMlClient.ListModelsPagedResponse listModels(String parent)

Lists models.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Model element : autoMlClient.listModels(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listModels

public final AutoMlClient.ListModelsPagedResponse listModels(ListModelsRequest request)

Lists models.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListModelsRequest request = ListModelsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Model element : autoMlClient.listModels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listModelsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,AutoMlClient.ListModelsPagedResponse> listModelsPagedCallable()

Lists models.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListModelsRequest request = ListModelsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListModelsPagedResponse> future = autoMlClient.listModelsPagedCallable().futureCall(request);
   // Do something
   for (Model element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listModelsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,ListModelsResponse> listModelsCallable()

Lists models.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListModelsRequest request = ListModelsRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

deleteModelAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteModelAsync(ModelName name)

Deletes a model. If a model is already deployed, this only deletes the model in AutoML BE, and does not change the status of the deployed model in the production environment. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Empty response = autoMlClient.deleteModelAsync(name).get();
 }
 

Parameters:

name - Resource name of the model being deleted.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteModelAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteModelAsync(String name)

Deletes a model. If a model is already deployed, this only deletes the model in AutoML BE, and does not change the status of the deployed model in the production environment. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Empty response = autoMlClient.deleteModelAsync(name.toString()).get();
 }
 

Parameters:

name - Resource name of the model being deleted.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteModelAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteModelAsync(DeleteModelRequest request)

Deletes a model. If a model is already deployed, this only deletes the model in AutoML BE, and does not change the status of the deployed model in the production environment. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   DeleteModelRequest request = DeleteModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   Empty response = autoMlClient.deleteModelAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteModelOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<DeleteModelRequest,com.google.protobuf.Empty,OperationMetadata> deleteModelOperationCallable()

Deletes a model. If a model is already deployed, this only deletes the model in AutoML BE, and does not change the status of the deployed model in the production environment. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   DeleteModelRequest request = DeleteModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   OperationFuture<Operation> future = autoMlClient.deleteModelOperationCallable().futureCall(request);
   // Do something
   Empty response = future.get();
 }
 

deleteModelCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteModelRequest,com.google.longrunning.Operation> deleteModelCallable()

Deletes a model. If a model is already deployed, this only deletes the model in AutoML BE, and does not change the status of the deployed model in the production environment. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   DeleteModelRequest request = DeleteModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = autoMlClient.deleteModelCallable().futureCall(request);
   // Do something
   future.get();
 }
 

deployModel

public final com.google.longrunning.Operation deployModel(ModelName name)

Deploys model. Returns a [DeployModelResponse][] in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Operation response = autoMlClient.deployModel(name);
 }
 

Parameters:

name - Resource name of the model to deploy.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deployModel

public final com.google.longrunning.Operation deployModel(String name)

Deploys model. Returns a [DeployModelResponse][] in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Operation response = autoMlClient.deployModel(name.toString());
 }
 

Parameters:

name - Resource name of the model to deploy.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deployModel

public final com.google.longrunning.Operation deployModel(DeployModelRequest request)

Deploys model. Returns a [DeployModelResponse][] in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   DeployModelRequest request = DeployModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   Operation response = autoMlClient.deployModel(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deployModelCallable

public final com.google.api.gax.rpc.UnaryCallable<DeployModelRequest,com.google.longrunning.Operation> deployModelCallable()

Deploys model. Returns a [DeployModelResponse][] in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   DeployModelRequest request = DeployModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = autoMlClient.deployModelCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

undeployModel

public final com.google.longrunning.Operation undeployModel(ModelName name)

Undeploys model. Returns an `UndeployModelResponse` in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Operation response = autoMlClient.undeployModel(name);
 }
 

Parameters:

name - Resource name of the model to undeploy.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

undeployModel

public final com.google.longrunning.Operation undeployModel(String name)

Undeploys model. Returns an `UndeployModelResponse` in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Operation response = autoMlClient.undeployModel(name.toString());
 }
 

Parameters:

name - Resource name of the model to undeploy.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

undeployModel

public final com.google.longrunning.Operation undeployModel(UndeployModelRequest request)

Undeploys model. Returns an `UndeployModelResponse` in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   UndeployModelRequest request = UndeployModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   Operation response = autoMlClient.undeployModel(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

undeployModelCallable

public final com.google.api.gax.rpc.UnaryCallable<UndeployModelRequest,com.google.longrunning.Operation> undeployModelCallable()

Undeploys model. Returns an `UndeployModelResponse` in the [response][google.longrunning.Operation.response] field when it completes.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   UndeployModelRequest request = UndeployModelRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = autoMlClient.undeployModelCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getModelEvaluation

public final ModelEvaluation getModelEvaluation(ModelEvaluationName name)

Gets a model evaluation.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelEvaluationName name = ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]");
   ModelEvaluation response = autoMlClient.getModelEvaluation(name);
 }
 

Parameters:

name - Resource name for the model evaluation.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getModelEvaluation

public final ModelEvaluation getModelEvaluation(String name)

Gets a model evaluation.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelEvaluationName name = ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]");
   ModelEvaluation response = autoMlClient.getModelEvaluation(name.toString());
 }
 

Parameters:

name - Resource name for the model evaluation.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getModelEvaluation

public final ModelEvaluation getModelEvaluation(GetModelEvaluationRequest request)

Gets a model evaluation.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelEvaluationName name = ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]");
   GetModelEvaluationRequest request = GetModelEvaluationRequest.newBuilder()
     .setName(name.toString())
     .build();
   ModelEvaluation response = autoMlClient.getModelEvaluation(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getModelEvaluationCallable

public final com.google.api.gax.rpc.UnaryCallable<GetModelEvaluationRequest,ModelEvaluation> getModelEvaluationCallable()

Gets a model evaluation.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelEvaluationName name = ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[MODEL_EVALUATION]");
   GetModelEvaluationRequest request = GetModelEvaluationRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ModelEvaluation> future = autoMlClient.getModelEvaluationCallable().futureCall(request);
   // Do something
   ModelEvaluation response = future.get();
 }
 

listModelEvaluations

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(ModelName parent)

Lists model evaluations.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   for (ModelEvaluation element : autoMlClient.listModelEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - 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.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listModelEvaluations

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(String parent)

Lists model evaluations.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   for (ModelEvaluation element : autoMlClient.listModelEvaluations(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - 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.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listModelEvaluations

public final AutoMlClient.ListModelEvaluationsPagedResponse listModelEvaluations(ListModelEvaluationsRequest request)

Lists model evaluations.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ListModelEvaluationsRequest request = ListModelEvaluationsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (ModelEvaluation element : autoMlClient.listModelEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listModelEvaluationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,AutoMlClient.ListModelEvaluationsPagedResponse> listModelEvaluationsPagedCallable()

Lists model evaluations.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ListModelEvaluationsRequest request = ListModelEvaluationsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListModelEvaluationsPagedResponse> future = autoMlClient.listModelEvaluationsPagedCallable().futureCall(request);
   // Do something
   for (ModelEvaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listModelEvaluationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsResponse> listModelEvaluationsCallable()

Lists model evaluations.

Sample code:

 try (AutoMlClient autoMlClient = AutoMlClient.create()) {
   ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   ListModelEvaluationsRequest request = ListModelEvaluationsRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException