Class AMLClient (0.1.0)

GitHub RepositoryProduct Reference

Service Description: The AML (Anti Money Laundering) service allows users to perform REST operations on aml.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = aMLClient.getInstance(name);
 }
 

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

Methods
Method Description Method Variants

ListInstances

Lists instances.

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

  • listInstances(ListInstancesRequest request)

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

  • listInstances(LocationName parent)

  • listInstances(String parent)

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

  • listInstancesPagedCallable()

  • listInstancesCallable()

GetInstance

Gets an instance.

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

  • getInstance(GetInstanceRequest request)

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

  • getInstance(InstanceName name)

  • getInstance(String name)

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

  • getInstanceCallable()

CreateInstance

Creates an instance.

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

  • createInstanceAsync(CreateInstanceRequest request)

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

  • createInstanceAsync(LocationName parent, Instance instance, String instanceId)

  • createInstanceAsync(String parent, Instance instance, String instanceId)

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

  • createInstanceOperationCallable()

  • createInstanceCallable()

UpdateInstance

Updates the parameters of a single Instance.

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

  • updateInstanceAsync(UpdateInstanceRequest request)

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

  • updateInstanceAsync(Instance instance, FieldMask updateMask)

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

  • updateInstanceOperationCallable()

  • updateInstanceCallable()

DeleteInstance

Deletes an instance.

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

  • deleteInstanceAsync(DeleteInstanceRequest request)

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

  • deleteInstanceAsync(InstanceName name)

  • deleteInstanceAsync(String name)

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

  • deleteInstanceOperationCallable()

  • deleteInstanceCallable()

ImportRegisteredParties

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

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

  • importRegisteredPartiesAsync(ImportRegisteredPartiesRequest request)

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

  • importRegisteredPartiesAsync(InstanceName name, ImportRegisteredPartiesRequest.UpdateMode mode, LineOfBusiness lineOfBusiness, List<String> partyTables)

  • importRegisteredPartiesAsync(String name, ImportRegisteredPartiesRequest.UpdateMode mode, LineOfBusiness lineOfBusiness, List<String> partyTables)

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

  • importRegisteredPartiesOperationCallable()

  • importRegisteredPartiesCallable()

ExportRegisteredParties

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

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

  • exportRegisteredPartiesAsync(ExportRegisteredPartiesRequest request)

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

  • exportRegisteredPartiesAsync(InstanceName name, BigQueryDestination dataset, LineOfBusiness lineOfBusiness)

  • exportRegisteredPartiesAsync(String name, BigQueryDestination dataset, LineOfBusiness lineOfBusiness)

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

  • exportRegisteredPartiesOperationCallable()

  • exportRegisteredPartiesCallable()

ListDatasets

Lists datasets.

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

  • listDatasets(ListDatasetsRequest request)

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

  • listDatasets(InstanceName parent)

  • listDatasets(String parent)

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

  • listDatasetsPagedCallable()

  • listDatasetsCallable()

GetDataset

Gets a dataset.

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

  • getDataset(GetDatasetRequest request)

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

  • getDataset(DatasetName name)

  • getDataset(String name)

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

  • getDatasetCallable()

CreateDataset

Creates a dataset.

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

  • createDatasetAsync(CreateDatasetRequest request)

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

  • createDatasetAsync(InstanceName parent, Dataset dataset, String datasetId)

  • createDatasetAsync(String parent, Dataset dataset, String datasetId)

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

  • createDatasetOperationCallable()

  • createDatasetCallable()

UpdateDataset

Updates the parameters of a single Dataset.

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

  • updateDatasetAsync(UpdateDatasetRequest request)

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

  • updateDatasetAsync(Dataset dataset, FieldMask updateMask)

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

  • updateDatasetOperationCallable()

  • updateDatasetCallable()

DeleteDataset

Deletes a dataset.

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

  • deleteDatasetAsync(DeleteDatasetRequest request)

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

  • deleteDatasetAsync(DatasetName name)

  • deleteDatasetAsync(String name)

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

  • deleteDatasetOperationCallable()

  • deleteDatasetCallable()

ListModels

Lists models.

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

  • listModels(ListModelsRequest request)

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

  • listModels(InstanceName parent)

  • listModels(String parent)

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

  • listModelsPagedCallable()

  • listModelsCallable()

GetModel

Gets a model.

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

  • getModel(GetModelRequest request)

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

  • getModel(ModelName name)

  • getModel(String name)

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

  • getModelCallable()

CreateModel

Creates a model.

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

  • createModelAsync(CreateModelRequest request)

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

  • createModelAsync(InstanceName parent, Model model, String modelId)

  • createModelAsync(String parent, Model model, String modelId)

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

  • createModelOperationCallable()

  • createModelCallable()

UpdateModel

Updates the parameters of a single Model.

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

  • updateModelAsync(UpdateModelRequest request)

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

  • updateModelAsync(Model model, FieldMask updateMask)

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

  • updateModelOperationCallable()

  • updateModelCallable()

ExportModelMetadata

Export governance information for a Model resource. For information on the exported fields, see AML output data model.

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

  • exportModelMetadataAsync(ExportModelMetadataRequest request)

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

  • exportModelMetadataAsync(ModelName model, BigQueryDestination structuredMetadataDestination)

  • exportModelMetadataAsync(String model, BigQueryDestination structuredMetadataDestination)

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

  • exportModelMetadataOperationCallable()

  • exportModelMetadataCallable()

DeleteModel

Deletes a model.

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

  • deleteModelAsync(DeleteModelRequest request)

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

  • deleteModelAsync(ModelName name)

  • deleteModelAsync(String name)

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

  • deleteModelOperationCallable()

  • deleteModelCallable()

ListEngineConfigs

Lists engine configs.

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

  • listEngineConfigs(ListEngineConfigsRequest request)

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

  • listEngineConfigs(InstanceName parent)

  • listEngineConfigs(String parent)

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

  • listEngineConfigsPagedCallable()

  • listEngineConfigsCallable()

GetEngineConfig

Gets an engine config.

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

  • getEngineConfig(GetEngineConfigRequest request)

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

  • getEngineConfig(EngineConfigName name)

  • getEngineConfig(String name)

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

  • getEngineConfigCallable()

CreateEngineConfig

Creates an engine config.

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

  • createEngineConfigAsync(CreateEngineConfigRequest request)

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

  • createEngineConfigAsync(InstanceName parent, EngineConfig engineConfig, String engineConfigId)

  • createEngineConfigAsync(String parent, EngineConfig engineConfig, String engineConfigId)

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

  • createEngineConfigOperationCallable()

  • createEngineConfigCallable()

UpdateEngineConfig

Updates the parameters of a single EngineConfig.

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

  • updateEngineConfigAsync(UpdateEngineConfigRequest request)

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

  • updateEngineConfigAsync(EngineConfig engineConfig, FieldMask updateMask)

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

  • updateEngineConfigOperationCallable()

  • updateEngineConfigCallable()

ExportEngineConfigMetadata

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data model.

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

  • exportEngineConfigMetadataAsync(ExportEngineConfigMetadataRequest request)

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

  • exportEngineConfigMetadataAsync(EngineConfigName engineConfig, BigQueryDestination structuredMetadataDestination)

  • exportEngineConfigMetadataAsync(String engineConfig, BigQueryDestination structuredMetadataDestination)

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

  • exportEngineConfigMetadataOperationCallable()

  • exportEngineConfigMetadataCallable()

DeleteEngineConfig

Deletes an engine config.

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

  • deleteEngineConfigAsync(DeleteEngineConfigRequest request)

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

  • deleteEngineConfigAsync(EngineConfigName name)

  • deleteEngineConfigAsync(String name)

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

  • deleteEngineConfigOperationCallable()

  • deleteEngineConfigCallable()

GetEngineVersion

Gets a single EngineVersion.

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

  • getEngineVersion(GetEngineVersionRequest request)

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

  • getEngineVersion(EngineVersionName name)

  • getEngineVersion(String name)

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

  • getEngineVersionCallable()

ListEngineVersions

Lists EngineVersions for given location.

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

  • listEngineVersions(ListEngineVersionsRequest request)

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

  • listEngineVersions(InstanceName parent)

  • listEngineVersions(String parent)

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

  • listEngineVersionsPagedCallable()

  • listEngineVersionsCallable()

ListPredictionResults

List PredictionResults.

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

  • listPredictionResults(ListPredictionResultsRequest request)

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

  • listPredictionResults(InstanceName parent)

  • listPredictionResults(String parent)

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

  • listPredictionResultsPagedCallable()

  • listPredictionResultsCallable()

GetPredictionResult

Gets a PredictionResult.

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

  • getPredictionResult(GetPredictionResultRequest request)

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

  • getPredictionResult(PredictionResultName name)

  • getPredictionResult(String name)

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

  • getPredictionResultCallable()

CreatePredictionResult

Create a PredictionResult.

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

  • createPredictionResultAsync(CreatePredictionResultRequest request)

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

  • createPredictionResultAsync(InstanceName parent, PredictionResult predictionResult, String predictionResultId)

  • createPredictionResultAsync(String parent, PredictionResult predictionResult, String predictionResultId)

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

  • createPredictionResultOperationCallable()

  • createPredictionResultCallable()

UpdatePredictionResult

Updates the parameters of a single PredictionResult.

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

  • updatePredictionResultAsync(UpdatePredictionResultRequest request)

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

  • updatePredictionResultAsync(PredictionResult predictionResult, FieldMask updateMask)

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

  • updatePredictionResultOperationCallable()

  • updatePredictionResultCallable()

ExportPredictionResultMetadata

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data model.

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

  • exportPredictionResultMetadataAsync(ExportPredictionResultMetadataRequest request)

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

  • exportPredictionResultMetadataAsync(PredictionResultName predictionResult, BigQueryDestination structuredMetadataDestination)

  • exportPredictionResultMetadataAsync(String predictionResult, BigQueryDestination structuredMetadataDestination)

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

  • exportPredictionResultMetadataOperationCallable()

  • exportPredictionResultMetadataCallable()

DeletePredictionResult

Deletes a PredictionResult.

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

  • deletePredictionResultAsync(DeletePredictionResultRequest request)

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

  • deletePredictionResultAsync(PredictionResultName name)

  • deletePredictionResultAsync(String name)

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

  • deletePredictionResultOperationCallable()

  • deletePredictionResultCallable()

ListBacktestResults

List BacktestResults.

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

  • listBacktestResults(ListBacktestResultsRequest request)

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

  • listBacktestResults(InstanceName parent)

  • listBacktestResults(String parent)

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

  • listBacktestResultsPagedCallable()

  • listBacktestResultsCallable()

GetBacktestResult

Gets a BacktestResult.

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

  • getBacktestResult(GetBacktestResultRequest request)

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

  • getBacktestResult(BacktestResultName name)

  • getBacktestResult(String name)

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

  • getBacktestResultCallable()

CreateBacktestResult

Create a BacktestResult.

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

  • createBacktestResultAsync(CreateBacktestResultRequest request)

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

  • createBacktestResultAsync(InstanceName parent, BacktestResult backtestResult, String backtestResultId)

  • createBacktestResultAsync(String parent, BacktestResult backtestResult, String backtestResultId)

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

  • createBacktestResultOperationCallable()

  • createBacktestResultCallable()

UpdateBacktestResult

Updates the parameters of a single BacktestResult.

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

  • updateBacktestResultAsync(UpdateBacktestResultRequest request)

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

  • updateBacktestResultAsync(BacktestResult backtestResult, FieldMask updateMask)

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

  • updateBacktestResultOperationCallable()

  • updateBacktestResultCallable()

ExportBacktestResultMetadata

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data model.

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

  • exportBacktestResultMetadataAsync(ExportBacktestResultMetadataRequest request)

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

  • exportBacktestResultMetadataAsync(BacktestResultName backtestResult, BigQueryDestination structuredMetadataDestination)

  • exportBacktestResultMetadataAsync(String backtestResult, BigQueryDestination structuredMetadataDestination)

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

  • exportBacktestResultMetadataOperationCallable()

  • exportBacktestResultMetadataCallable()

DeleteBacktestResult

Deletes a BacktestResult.

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

  • deleteBacktestResultAsync(DeleteBacktestResultRequest request)

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

  • deleteBacktestResultAsync(BacktestResultName name)

  • deleteBacktestResultAsync(String name)

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

  • deleteBacktestResultOperationCallable()

  • deleteBacktestResultCallable()

ListLocations

Lists information about the supported locations for this service.

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

  • listLocations(ListLocationsRequest request)

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

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

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

  • getLocationCallable()

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 AMLSettings 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
 AMLSettings aMLSettings =
     AMLSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AMLClient aMLClient = AMLClient.create(aMLSettings);
 

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
 AMLSettings aMLSettings = AMLSettings.newBuilder().setEndpoint(myEndpoint).build();
 AMLClient aMLClient = AMLClient.create(aMLSettings);
 

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
 AMLSettings aMLSettings = AMLSettings.newHttpJsonBuilder().build();
 AMLClient aMLClient = AMLClient.create(aMLSettings);
 

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

Inheritance

java.lang.Object > AMLClient

Static Methods

create()

public static final AMLClient create()

Constructs an instance of AMLClient with default settings.

Returns
Type Description
AMLClient
Exceptions
Type Description
IOException

create(AMLSettings settings)

public static final AMLClient create(AMLSettings settings)

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

Parameter
Name Description
settings AMLSettings
Returns
Type Description
AMLClient
Exceptions
Type Description
IOException

create(AMLStub stub)

public static final AMLClient create(AMLStub stub)

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

Parameter
Name Description
stub AMLStub
Returns
Type Description
AMLClient

Constructors

AMLClient(AMLSettings settings)

protected AMLClient(AMLSettings settings)

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

Parameter
Name Description
settings AMLSettings

AMLClient(AMLStub stub)

protected AMLClient(AMLStub stub)
Parameter
Name Description
stub AMLStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

createBacktestResultAsync(CreateBacktestResultRequest request)

public final OperationFuture<BacktestResult,OperationMetadata> createBacktestResultAsync(CreateBacktestResultRequest request)

Create a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateBacktestResultRequest request =
       CreateBacktestResultRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setBacktestResultId("backtestResultId-2045569231")
           .setBacktestResult(BacktestResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   BacktestResult response = aMLClient.createBacktestResultAsync(request).get();
 }
 
Parameter
Name Description
request CreateBacktestResultRequest

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

Returns
Type Description
OperationFuture<BacktestResult,OperationMetadata>

createBacktestResultAsync(InstanceName parent, BacktestResult backtestResult, String backtestResultId)

public final OperationFuture<BacktestResult,OperationMetadata> createBacktestResultAsync(InstanceName parent, BacktestResult backtestResult, String backtestResultId)

Create a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   BacktestResult backtestResult = BacktestResult.newBuilder().build();
   String backtestResultId = "backtestResultId-2045569231";
   BacktestResult response =
       aMLClient.createBacktestResultAsync(parent, backtestResult, backtestResultId).get();
 }
 
Parameters
Name Description
parent InstanceName

Required. The parent of the BacktestResult is the Instance.

backtestResult BacktestResult

Required. The BacktestResult that will be created.

backtestResultId String

Required. The resource id of the BacktestResult

Returns
Type Description
OperationFuture<BacktestResult,OperationMetadata>

createBacktestResultAsync(String parent, BacktestResult backtestResult, String backtestResultId)

public final OperationFuture<BacktestResult,OperationMetadata> createBacktestResultAsync(String parent, BacktestResult backtestResult, String backtestResultId)

Create a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   BacktestResult backtestResult = BacktestResult.newBuilder().build();
   String backtestResultId = "backtestResultId-2045569231";
   BacktestResult response =
       aMLClient.createBacktestResultAsync(parent, backtestResult, backtestResultId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent of the BacktestResult is the Instance.

backtestResult BacktestResult

Required. The BacktestResult that will be created.

backtestResultId String

Required. The resource id of the BacktestResult

Returns
Type Description
OperationFuture<BacktestResult,OperationMetadata>

createBacktestResultCallable()

public final UnaryCallable<CreateBacktestResultRequest,Operation> createBacktestResultCallable()

Create a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateBacktestResultRequest request =
       CreateBacktestResultRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setBacktestResultId("backtestResultId-2045569231")
           .setBacktestResult(BacktestResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.createBacktestResultCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateBacktestResultRequest,Operation>

createBacktestResultOperationCallable()

public final OperationCallable<CreateBacktestResultRequest,BacktestResult,OperationMetadata> createBacktestResultOperationCallable()

Create a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateBacktestResultRequest request =
       CreateBacktestResultRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setBacktestResultId("backtestResultId-2045569231")
           .setBacktestResult(BacktestResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<BacktestResult, OperationMetadata> future =
       aMLClient.createBacktestResultOperationCallable().futureCall(request);
   // Do something.
   BacktestResult response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateBacktestResultRequest,BacktestResult,OperationMetadata>

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDatasetId("datasetId-345342029")
           .setDataset(Dataset.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Dataset response = aMLClient.createDatasetAsync(request).get();
 }
 
Parameter
Name Description
request CreateDatasetRequest

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

Returns
Type Description
OperationFuture<Dataset,OperationMetadata>

createDatasetAsync(InstanceName parent, Dataset dataset, String datasetId)

public final OperationFuture<Dataset,OperationMetadata> createDatasetAsync(InstanceName parent, Dataset dataset, String datasetId)

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Dataset dataset = Dataset.newBuilder().build();
   String datasetId = "datasetId-345342029";
   Dataset response = aMLClient.createDatasetAsync(parent, dataset, datasetId).get();
 }
 
Parameters
Name Description
parent InstanceName

Required. The parent of the Dataset is the Instance.

dataset Dataset

Required. The dataset that will be created.

datasetId String

Required. The resource id of the dataset

Returns
Type Description
OperationFuture<Dataset,OperationMetadata>

createDatasetAsync(String parent, Dataset dataset, String datasetId)

public final OperationFuture<Dataset,OperationMetadata> createDatasetAsync(String parent, Dataset dataset, String datasetId)

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Dataset dataset = Dataset.newBuilder().build();
   String datasetId = "datasetId-345342029";
   Dataset response = aMLClient.createDatasetAsync(parent, dataset, datasetId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent of the Dataset is the Instance.

dataset Dataset

Required. The dataset that will be created.

datasetId String

Required. The resource id of the dataset

Returns
Type Description
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 (AMLClient aMLClient = AMLClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDatasetId("datasetId-345342029")
           .setDataset(Dataset.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.createDatasetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
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 (AMLClient aMLClient = AMLClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDatasetId("datasetId-345342029")
           .setDataset(Dataset.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Dataset, OperationMetadata> future =
       aMLClient.createDatasetOperationCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateDatasetRequest,Dataset,OperationMetadata>

createEngineConfigAsync(CreateEngineConfigRequest request)

public final OperationFuture<EngineConfig,OperationMetadata> createEngineConfigAsync(CreateEngineConfigRequest request)

Creates an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateEngineConfigRequest request =
       CreateEngineConfigRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setEngineConfigId("engineConfigId451461215")
           .setEngineConfig(EngineConfig.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   EngineConfig response = aMLClient.createEngineConfigAsync(request).get();
 }
 
Parameter
Name Description
request CreateEngineConfigRequest

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

Returns
Type Description
OperationFuture<EngineConfig,OperationMetadata>

createEngineConfigAsync(InstanceName parent, EngineConfig engineConfig, String engineConfigId)

public final OperationFuture<EngineConfig,OperationMetadata> createEngineConfigAsync(InstanceName parent, EngineConfig engineConfig, String engineConfigId)

Creates an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   EngineConfig engineConfig = EngineConfig.newBuilder().build();
   String engineConfigId = "engineConfigId451461215";
   EngineConfig response =
       aMLClient.createEngineConfigAsync(parent, engineConfig, engineConfigId).get();
 }
 
Parameters
Name Description
parent InstanceName

Required. The parent of the EngineConfig is the Instance.

engineConfig EngineConfig

Required. The EngineConfig that will be created.

engineConfigId String

Required. The resource id of the EngineConfig

Returns
Type Description
OperationFuture<EngineConfig,OperationMetadata>

createEngineConfigAsync(String parent, EngineConfig engineConfig, String engineConfigId)

public final OperationFuture<EngineConfig,OperationMetadata> createEngineConfigAsync(String parent, EngineConfig engineConfig, String engineConfigId)

Creates an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   EngineConfig engineConfig = EngineConfig.newBuilder().build();
   String engineConfigId = "engineConfigId451461215";
   EngineConfig response =
       aMLClient.createEngineConfigAsync(parent, engineConfig, engineConfigId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent of the EngineConfig is the Instance.

engineConfig EngineConfig

Required. The EngineConfig that will be created.

engineConfigId String

Required. The resource id of the EngineConfig

Returns
Type Description
OperationFuture<EngineConfig,OperationMetadata>

createEngineConfigCallable()

public final UnaryCallable<CreateEngineConfigRequest,Operation> createEngineConfigCallable()

Creates an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateEngineConfigRequest request =
       CreateEngineConfigRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setEngineConfigId("engineConfigId451461215")
           .setEngineConfig(EngineConfig.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.createEngineConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateEngineConfigRequest,Operation>

createEngineConfigOperationCallable()

public final OperationCallable<CreateEngineConfigRequest,EngineConfig,OperationMetadata> createEngineConfigOperationCallable()

Creates an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateEngineConfigRequest request =
       CreateEngineConfigRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setEngineConfigId("engineConfigId451461215")
           .setEngineConfig(EngineConfig.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<EngineConfig, OperationMetadata> future =
       aMLClient.createEngineConfigOperationCallable().futureCall(request);
   // Do something.
   EngineConfig response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateEngineConfigRequest,EngineConfig,OperationMetadata>

createInstanceAsync(CreateInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)

Creates an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Instance response = aMLClient.createInstanceAsync(request).get();
 }
 
Parameter
Name Description
request CreateInstanceRequest

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

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

createInstanceAsync(LocationName parent, Instance instance, String instanceId)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(LocationName parent, Instance instance, String instanceId)

Creates an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Instance instance = Instance.newBuilder().build();
   String instanceId = "instanceId902024336";
   Instance response = aMLClient.createInstanceAsync(parent, instance, instanceId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

instance Instance

Required. The instance that will be created.

instanceId String

Required. The resource id of the instance.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

createInstanceAsync(String parent, Instance instance, String instanceId)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(String parent, Instance instance, String instanceId)

Creates an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Instance instance = Instance.newBuilder().build();
   String instanceId = "instanceId902024336";
   Instance response = aMLClient.createInstanceAsync(parent, instance, instanceId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

instance Instance

Required. The instance that will be created.

instanceId String

Required. The resource id of the instance.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

createInstanceCallable()

public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()

Creates an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.createInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateInstanceRequest,Operation>

createInstanceOperationCallable()

public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()

Creates an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstanceId("instanceId902024336")
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       aMLClient.createInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateInstanceRequest,Instance,OperationMetadata>

createModelAsync(CreateModelRequest request)

public final OperationFuture<Model,OperationMetadata> createModelAsync(CreateModelRequest request)

Creates 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 (AMLClient aMLClient = AMLClient.create()) {
   CreateModelRequest request =
       CreateModelRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setModelId("modelId1226956324")
           .setModel(Model.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Model response = aMLClient.createModelAsync(request).get();
 }
 
Parameter
Name Description
request CreateModelRequest

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

Returns
Type Description
OperationFuture<Model,OperationMetadata>

createModelAsync(InstanceName parent, Model model, String modelId)

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

Creates 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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Model model = Model.newBuilder().build();
   String modelId = "modelId1226956324";
   Model response = aMLClient.createModelAsync(parent, model, modelId).get();
 }
 
Parameters
Name Description
parent InstanceName

Required. The parent of the Model is the Instance.

model Model

Required. The Model that will be created.

modelId String

Required. The resource id of the Model

Returns
Type Description
OperationFuture<Model,OperationMetadata>

createModelAsync(String parent, Model model, String modelId)

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

Creates 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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Model model = Model.newBuilder().build();
   String modelId = "modelId1226956324";
   Model response = aMLClient.createModelAsync(parent, model, modelId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent of the Model is the Instance.

model Model

Required. The Model that will be created.

modelId String

Required. The resource id of the Model

Returns
Type Description
OperationFuture<Model,OperationMetadata>

createModelCallable()

public final UnaryCallable<CreateModelRequest,Operation> createModelCallable()

Creates 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 (AMLClient aMLClient = AMLClient.create()) {
   CreateModelRequest request =
       CreateModelRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setModelId("modelId1226956324")
           .setModel(Model.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.createModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateModelRequest,Operation>

createModelOperationCallable()

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

Creates a model.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreateModelRequest request =
       CreateModelRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setModelId("modelId1226956324")
           .setModel(Model.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Model, OperationMetadata> future =
       aMLClient.createModelOperationCallable().futureCall(request);
   // Do something.
   Model response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateModelRequest,Model,OperationMetadata>

createPredictionResultAsync(CreatePredictionResultRequest request)

public final OperationFuture<PredictionResult,OperationMetadata> createPredictionResultAsync(CreatePredictionResultRequest request)

Create a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreatePredictionResultRequest request =
       CreatePredictionResultRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPredictionResultId("predictionResultId62892999")
           .setPredictionResult(PredictionResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   PredictionResult response = aMLClient.createPredictionResultAsync(request).get();
 }
 
Parameter
Name Description
request CreatePredictionResultRequest

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

Returns
Type Description
OperationFuture<PredictionResult,OperationMetadata>

createPredictionResultAsync(InstanceName parent, PredictionResult predictionResult, String predictionResultId)

public final OperationFuture<PredictionResult,OperationMetadata> createPredictionResultAsync(InstanceName parent, PredictionResult predictionResult, String predictionResultId)

Create a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   PredictionResult predictionResult = PredictionResult.newBuilder().build();
   String predictionResultId = "predictionResultId62892999";
   PredictionResult response =
       aMLClient.createPredictionResultAsync(parent, predictionResult, predictionResultId).get();
 }
 
Parameters
Name Description
parent InstanceName

Required. The parent of the PredictionResult is the Instance.

predictionResult PredictionResult

Required. The PredictionResult that will be created.

predictionResultId String

Required. The resource id of the PredictionResult

Returns
Type Description
OperationFuture<PredictionResult,OperationMetadata>

createPredictionResultAsync(String parent, PredictionResult predictionResult, String predictionResultId)

public final OperationFuture<PredictionResult,OperationMetadata> createPredictionResultAsync(String parent, PredictionResult predictionResult, String predictionResultId)

Create a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   PredictionResult predictionResult = PredictionResult.newBuilder().build();
   String predictionResultId = "predictionResultId62892999";
   PredictionResult response =
       aMLClient.createPredictionResultAsync(parent, predictionResult, predictionResultId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent of the PredictionResult is the Instance.

predictionResult PredictionResult

Required. The PredictionResult that will be created.

predictionResultId String

Required. The resource id of the PredictionResult

Returns
Type Description
OperationFuture<PredictionResult,OperationMetadata>

createPredictionResultCallable()

public final UnaryCallable<CreatePredictionResultRequest,Operation> createPredictionResultCallable()

Create a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreatePredictionResultRequest request =
       CreatePredictionResultRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPredictionResultId("predictionResultId62892999")
           .setPredictionResult(PredictionResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.createPredictionResultCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreatePredictionResultRequest,Operation>

createPredictionResultOperationCallable()

public final OperationCallable<CreatePredictionResultRequest,PredictionResult,OperationMetadata> createPredictionResultOperationCallable()

Create a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   CreatePredictionResultRequest request =
       CreatePredictionResultRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPredictionResultId("predictionResultId62892999")
           .setPredictionResult(PredictionResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PredictionResult, OperationMetadata> future =
       aMLClient.createPredictionResultOperationCallable().futureCall(request);
   // Do something.
   PredictionResult response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreatePredictionResultRequest,PredictionResult,OperationMetadata>

deleteBacktestResultAsync(BacktestResultName name)

public final OperationFuture<Empty,OperationMetadata> deleteBacktestResultAsync(BacktestResultName name)

Deletes a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   BacktestResultName name =
       BacktestResultName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]");
   aMLClient.deleteBacktestResultAsync(name).get();
 }
 
Parameter
Name Description
name BacktestResultName

Required. The resource name of the BacktestResult.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBacktestResultAsync(DeleteBacktestResultRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBacktestResultAsync(DeleteBacktestResultRequest request)

Deletes a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteBacktestResultRequest request =
       DeleteBacktestResultRequest.newBuilder()
           .setName(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   aMLClient.deleteBacktestResultAsync(request).get();
 }
 
Parameter
Name Description
request DeleteBacktestResultRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBacktestResultAsync(String name)

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

Deletes a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       BacktestResultName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
           .toString();
   aMLClient.deleteBacktestResultAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the BacktestResult.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteBacktestResultCallable()

public final UnaryCallable<DeleteBacktestResultRequest,Operation> deleteBacktestResultCallable()

Deletes a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteBacktestResultRequest request =
       DeleteBacktestResultRequest.newBuilder()
           .setName(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.deleteBacktestResultCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteBacktestResultRequest,Operation>

deleteBacktestResultOperationCallable()

public final OperationCallable<DeleteBacktestResultRequest,Empty,OperationMetadata> deleteBacktestResultOperationCallable()

Deletes a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteBacktestResultRequest request =
       DeleteBacktestResultRequest.newBuilder()
           .setName(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       aMLClient.deleteBacktestResultOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteBacktestResultRequest,Empty,OperationMetadata>

deleteDatasetAsync(DatasetName name)

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

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[DATASET]");
   aMLClient.deleteDatasetAsync(name).get();
 }
 
Parameter
Name Description
name DatasetName

Required. The resource name of the Dataset.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDatasetAsync(DeleteDatasetRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteDatasetAsync(DeleteDatasetRequest request)

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(
               DatasetName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[DATASET]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   aMLClient.deleteDatasetAsync(request).get();
 }
 
Parameter
Name Description
request DeleteDatasetRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDatasetAsync(String name)

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

Deletes a dataset.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       DatasetName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[DATASET]").toString();
   aMLClient.deleteDatasetAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the Dataset.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteDatasetCallable()

public final UnaryCallable<DeleteDatasetRequest,Operation> deleteDatasetCallable()

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(
               DatasetName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[DATASET]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.deleteDatasetCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteDatasetRequest,Operation>

deleteDatasetOperationCallable()

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

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(
               DatasetName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[DATASET]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       aMLClient.deleteDatasetOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteDatasetRequest,Empty,OperationMetadata>

deleteEngineConfigAsync(DeleteEngineConfigRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteEngineConfigAsync(DeleteEngineConfigRequest request)

Deletes an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteEngineConfigRequest request =
       DeleteEngineConfigRequest.newBuilder()
           .setName(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   aMLClient.deleteEngineConfigAsync(request).get();
 }
 
Parameter
Name Description
request DeleteEngineConfigRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEngineConfigAsync(EngineConfigName name)

public final OperationFuture<Empty,OperationMetadata> deleteEngineConfigAsync(EngineConfigName name)

Deletes an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   EngineConfigName name =
       EngineConfigName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]");
   aMLClient.deleteEngineConfigAsync(name).get();
 }
 
Parameter
Name Description
name EngineConfigName

Required. The resource name of the EngineConfig.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEngineConfigAsync(String name)

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

Deletes an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       EngineConfigName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
           .toString();
   aMLClient.deleteEngineConfigAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the EngineConfig.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteEngineConfigCallable()

public final UnaryCallable<DeleteEngineConfigRequest,Operation> deleteEngineConfigCallable()

Deletes an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteEngineConfigRequest request =
       DeleteEngineConfigRequest.newBuilder()
           .setName(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.deleteEngineConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEngineConfigRequest,Operation>

deleteEngineConfigOperationCallable()

public final OperationCallable<DeleteEngineConfigRequest,Empty,OperationMetadata> deleteEngineConfigOperationCallable()

Deletes an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteEngineConfigRequest request =
       DeleteEngineConfigRequest.newBuilder()
           .setName(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       aMLClient.deleteEngineConfigOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteEngineConfigRequest,Empty,OperationMetadata>

deleteInstanceAsync(DeleteInstanceRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)

Deletes an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .build();
   aMLClient.deleteInstanceAsync(request).get();
 }
 
Parameter
Name Description
request DeleteInstanceRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteInstanceAsync(InstanceName name)

public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(InstanceName name)

Deletes an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   aMLClient.deleteInstanceAsync(name).get();
 }
 
Parameter
Name Description
name InstanceName

Required. The resource name of the Instance.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteInstanceAsync(String name)

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

Deletes an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   aMLClient.deleteInstanceAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the Instance.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteInstanceCallable()

public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()

Deletes an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.deleteInstanceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteInstanceRequest,Operation>

deleteInstanceOperationCallable()

public final OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationCallable()

Deletes an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       aMLClient.deleteInstanceOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata>

deleteModelAsync(DeleteModelRequest request)

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

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteModelRequest request =
       DeleteModelRequest.newBuilder()
           .setName(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .setRequestId("requestId693933066")
           .build();
   aMLClient.deleteModelAsync(request).get();
 }
 
Parameter
Name Description
request DeleteModelRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteModelAsync(ModelName name)

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

Deletes a model.

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 (AMLClient aMLClient = AMLClient.create()) {
   ModelName name = ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]");
   aMLClient.deleteModelAsync(name).get();
 }
 
Parameter
Name Description
name ModelName

Required. The resource name of the Model.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteModelAsync(String name)

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

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   String name = ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString();
   aMLClient.deleteModelAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the Model.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteModelCallable()

public final UnaryCallable<DeleteModelRequest,Operation> deleteModelCallable()

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteModelRequest request =
       DeleteModelRequest.newBuilder()
           .setName(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.deleteModelCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteModelRequest,Operation>

deleteModelOperationCallable()

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

Deletes 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 (AMLClient aMLClient = AMLClient.create()) {
   DeleteModelRequest request =
       DeleteModelRequest.newBuilder()
           .setName(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       aMLClient.deleteModelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteModelRequest,Empty,OperationMetadata>

deletePredictionResultAsync(DeletePredictionResultRequest request)

public final OperationFuture<Empty,OperationMetadata> deletePredictionResultAsync(DeletePredictionResultRequest request)

Deletes a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeletePredictionResultRequest request =
       DeletePredictionResultRequest.newBuilder()
           .setName(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   aMLClient.deletePredictionResultAsync(request).get();
 }
 
Parameter
Name Description
request DeletePredictionResultRequest

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

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePredictionResultAsync(PredictionResultName name)

public final OperationFuture<Empty,OperationMetadata> deletePredictionResultAsync(PredictionResultName name)

Deletes a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   PredictionResultName name =
       PredictionResultName.of(
           "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]");
   aMLClient.deletePredictionResultAsync(name).get();
 }
 
Parameter
Name Description
name PredictionResultName

Required. The resource name of the PredictionResult.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePredictionResultAsync(String name)

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

Deletes a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       PredictionResultName.of(
               "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
           .toString();
   aMLClient.deletePredictionResultAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the PredictionResult.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePredictionResultCallable()

public final UnaryCallable<DeletePredictionResultRequest,Operation> deletePredictionResultCallable()

Deletes a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeletePredictionResultRequest request =
       DeletePredictionResultRequest.newBuilder()
           .setName(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.deletePredictionResultCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeletePredictionResultRequest,Operation>

deletePredictionResultOperationCallable()

public final OperationCallable<DeletePredictionResultRequest,Empty,OperationMetadata> deletePredictionResultOperationCallable()

Deletes a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   DeletePredictionResultRequest request =
       DeletePredictionResultRequest.newBuilder()
           .setName(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       aMLClient.deletePredictionResultOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeletePredictionResultRequest,Empty,OperationMetadata>

exportBacktestResultMetadataAsync(BacktestResultName backtestResult, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportBacktestResultMetadataResponse,OperationMetadata> exportBacktestResultMetadataAsync(BacktestResultName backtestResult, BigQueryDestination structuredMetadataDestination)

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   BacktestResultName backtestResult =
       BacktestResultName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]");
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportBacktestResultMetadataResponse response =
       aMLClient
           .exportBacktestResultMetadataAsync(backtestResult, structuredMetadataDestination)
           .get();
 }
 
Parameters
Name Description
backtestResult BacktestResultName

Required. The resource name of the BacktestResult.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportBacktestResultMetadataResponse,OperationMetadata>

exportBacktestResultMetadataAsync(ExportBacktestResultMetadataRequest request)

public final OperationFuture<ExportBacktestResultMetadataResponse,OperationMetadata> exportBacktestResultMetadataAsync(ExportBacktestResultMetadataRequest request)

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportBacktestResultMetadataRequest request =
       ExportBacktestResultMetadataRequest.newBuilder()
           .setBacktestResult(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ExportBacktestResultMetadataResponse response =
       aMLClient.exportBacktestResultMetadataAsync(request).get();
 }
 
Parameter
Name Description
request ExportBacktestResultMetadataRequest

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

Returns
Type Description
OperationFuture<ExportBacktestResultMetadataResponse,OperationMetadata>

exportBacktestResultMetadataAsync(String backtestResult, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportBacktestResultMetadataResponse,OperationMetadata> exportBacktestResultMetadataAsync(String backtestResult, BigQueryDestination structuredMetadataDestination)

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   String backtestResult =
       BacktestResultName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
           .toString();
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportBacktestResultMetadataResponse response =
       aMLClient
           .exportBacktestResultMetadataAsync(backtestResult, structuredMetadataDestination)
           .get();
 }
 
Parameters
Name Description
backtestResult String

Required. The resource name of the BacktestResult.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportBacktestResultMetadataResponse,OperationMetadata>

exportBacktestResultMetadataCallable()

public final UnaryCallable<ExportBacktestResultMetadataRequest,Operation> exportBacktestResultMetadataCallable()

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportBacktestResultMetadataRequest request =
       ExportBacktestResultMetadataRequest.newBuilder()
           .setBacktestResult(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       aMLClient.exportBacktestResultMetadataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ExportBacktestResultMetadataRequest,Operation>

exportBacktestResultMetadataOperationCallable()

public final OperationCallable<ExportBacktestResultMetadataRequest,ExportBacktestResultMetadataResponse,OperationMetadata> exportBacktestResultMetadataOperationCallable()

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportBacktestResultMetadataRequest request =
       ExportBacktestResultMetadataRequest.newBuilder()
           .setBacktestResult(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   OperationFuture<ExportBacktestResultMetadataResponse, OperationMetadata> future =
       aMLClient.exportBacktestResultMetadataOperationCallable().futureCall(request);
   // Do something.
   ExportBacktestResultMetadataResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ExportBacktestResultMetadataRequest,ExportBacktestResultMetadataResponse,OperationMetadata>

exportEngineConfigMetadataAsync(EngineConfigName engineConfig, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportEngineConfigMetadataResponse,OperationMetadata> exportEngineConfigMetadataAsync(EngineConfigName engineConfig, BigQueryDestination structuredMetadataDestination)

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   EngineConfigName engineConfig =
       EngineConfigName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]");
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportEngineConfigMetadataResponse response =
       aMLClient
           .exportEngineConfigMetadataAsync(engineConfig, structuredMetadataDestination)
           .get();
 }
 
Parameters
Name Description
engineConfig EngineConfigName

Required. The resource name of the EngineConfig.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportEngineConfigMetadataResponse,OperationMetadata>

exportEngineConfigMetadataAsync(ExportEngineConfigMetadataRequest request)

public final OperationFuture<ExportEngineConfigMetadataResponse,OperationMetadata> exportEngineConfigMetadataAsync(ExportEngineConfigMetadataRequest request)

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportEngineConfigMetadataRequest request =
       ExportEngineConfigMetadataRequest.newBuilder()
           .setEngineConfig(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ExportEngineConfigMetadataResponse response =
       aMLClient.exportEngineConfigMetadataAsync(request).get();
 }
 
Parameter
Name Description
request ExportEngineConfigMetadataRequest

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

Returns
Type Description
OperationFuture<ExportEngineConfigMetadataResponse,OperationMetadata>

exportEngineConfigMetadataAsync(String engineConfig, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportEngineConfigMetadataResponse,OperationMetadata> exportEngineConfigMetadataAsync(String engineConfig, BigQueryDestination structuredMetadataDestination)

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   String engineConfig =
       EngineConfigName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
           .toString();
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportEngineConfigMetadataResponse response =
       aMLClient
           .exportEngineConfigMetadataAsync(engineConfig, structuredMetadataDestination)
           .get();
 }
 
Parameters
Name Description
engineConfig String

Required. The resource name of the EngineConfig.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportEngineConfigMetadataResponse,OperationMetadata>

exportEngineConfigMetadataCallable()

public final UnaryCallable<ExportEngineConfigMetadataRequest,Operation> exportEngineConfigMetadataCallable()

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportEngineConfigMetadataRequest request =
       ExportEngineConfigMetadataRequest.newBuilder()
           .setEngineConfig(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       aMLClient.exportEngineConfigMetadataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ExportEngineConfigMetadataRequest,Operation>

exportEngineConfigMetadataOperationCallable()

public final OperationCallable<ExportEngineConfigMetadataRequest,ExportEngineConfigMetadataResponse,OperationMetadata> exportEngineConfigMetadataOperationCallable()

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportEngineConfigMetadataRequest request =
       ExportEngineConfigMetadataRequest.newBuilder()
           .setEngineConfig(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   OperationFuture<ExportEngineConfigMetadataResponse, OperationMetadata> future =
       aMLClient.exportEngineConfigMetadataOperationCallable().futureCall(request);
   // Do something.
   ExportEngineConfigMetadataResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ExportEngineConfigMetadataRequest,ExportEngineConfigMetadataResponse,OperationMetadata>

exportModelMetadataAsync(ExportModelMetadataRequest request)

public final OperationFuture<ExportModelMetadataResponse,OperationMetadata> exportModelMetadataAsync(ExportModelMetadataRequest request)

Export governance information for a Model resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportModelMetadataRequest request =
       ExportModelMetadataRequest.newBuilder()
           .setModel(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ExportModelMetadataResponse response = aMLClient.exportModelMetadataAsync(request).get();
 }
 
Parameter
Name Description
request ExportModelMetadataRequest

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

Returns
Type Description
OperationFuture<ExportModelMetadataResponse,OperationMetadata>

exportModelMetadataAsync(ModelName model, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportModelMetadataResponse,OperationMetadata> exportModelMetadataAsync(ModelName model, BigQueryDestination structuredMetadataDestination)

Export governance information for a Model resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ModelName model = ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]");
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportModelMetadataResponse response =
       aMLClient.exportModelMetadataAsync(model, structuredMetadataDestination).get();
 }
 
Parameters
Name Description
model ModelName

Required. The resource name of the Model.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportModelMetadataResponse,OperationMetadata>

exportModelMetadataAsync(String model, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportModelMetadataResponse,OperationMetadata> exportModelMetadataAsync(String model, BigQueryDestination structuredMetadataDestination)

Export governance information for a Model resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   String model =
       ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString();
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportModelMetadataResponse response =
       aMLClient.exportModelMetadataAsync(model, structuredMetadataDestination).get();
 }
 
Parameters
Name Description
model String

Required. The resource name of the Model.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportModelMetadataResponse,OperationMetadata>

exportModelMetadataCallable()

public final UnaryCallable<ExportModelMetadataRequest,Operation> exportModelMetadataCallable()

Export governance information for a Model resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportModelMetadataRequest request =
       ExportModelMetadataRequest.newBuilder()
           .setModel(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ApiFuture<Operation> future = aMLClient.exportModelMetadataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ExportModelMetadataRequest,Operation>

exportModelMetadataOperationCallable()

public final OperationCallable<ExportModelMetadataRequest,ExportModelMetadataResponse,OperationMetadata> exportModelMetadataOperationCallable()

Export governance information for a Model resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportModelMetadataRequest request =
       ExportModelMetadataRequest.newBuilder()
           .setModel(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   OperationFuture<ExportModelMetadataResponse, OperationMetadata> future =
       aMLClient.exportModelMetadataOperationCallable().futureCall(request);
   // Do something.
   ExportModelMetadataResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ExportModelMetadataRequest,ExportModelMetadataResponse,OperationMetadata>

exportPredictionResultMetadataAsync(ExportPredictionResultMetadataRequest request)

public final OperationFuture<ExportPredictionResultMetadataResponse,OperationMetadata> exportPredictionResultMetadataAsync(ExportPredictionResultMetadataRequest request)

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportPredictionResultMetadataRequest request =
       ExportPredictionResultMetadataRequest.newBuilder()
           .setPredictionResult(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ExportPredictionResultMetadataResponse response =
       aMLClient.exportPredictionResultMetadataAsync(request).get();
 }
 
Parameter
Name Description
request ExportPredictionResultMetadataRequest

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

Returns
Type Description
OperationFuture<ExportPredictionResultMetadataResponse,OperationMetadata>

exportPredictionResultMetadataAsync(PredictionResultName predictionResult, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportPredictionResultMetadataResponse,OperationMetadata> exportPredictionResultMetadataAsync(PredictionResultName predictionResult, BigQueryDestination structuredMetadataDestination)

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   PredictionResultName predictionResult =
       PredictionResultName.of(
           "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]");
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportPredictionResultMetadataResponse response =
       aMLClient
           .exportPredictionResultMetadataAsync(predictionResult, structuredMetadataDestination)
           .get();
 }
 
Parameters
Name Description
predictionResult PredictionResultName

Required. The resource name of the PredictionResult.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportPredictionResultMetadataResponse,OperationMetadata>

exportPredictionResultMetadataAsync(String predictionResult, BigQueryDestination structuredMetadataDestination)

public final OperationFuture<ExportPredictionResultMetadataResponse,OperationMetadata> exportPredictionResultMetadataAsync(String predictionResult, BigQueryDestination structuredMetadataDestination)

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   String predictionResult =
       PredictionResultName.of(
               "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
           .toString();
   BigQueryDestination structuredMetadataDestination = BigQueryDestination.newBuilder().build();
   ExportPredictionResultMetadataResponse response =
       aMLClient
           .exportPredictionResultMetadataAsync(predictionResult, structuredMetadataDestination)
           .get();
 }
 
Parameters
Name Description
predictionResult String

Required. The resource name of the PredictionResult.

structuredMetadataDestination BigQueryDestination

Required. BigQuery output where the metadata will be written.

Returns
Type Description
OperationFuture<ExportPredictionResultMetadataResponse,OperationMetadata>

exportPredictionResultMetadataCallable()

public final UnaryCallable<ExportPredictionResultMetadataRequest,Operation> exportPredictionResultMetadataCallable()

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportPredictionResultMetadataRequest request =
       ExportPredictionResultMetadataRequest.newBuilder()
           .setPredictionResult(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       aMLClient.exportPredictionResultMetadataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ExportPredictionResultMetadataRequest,Operation>

exportPredictionResultMetadataOperationCallable()

public final OperationCallable<ExportPredictionResultMetadataRequest,ExportPredictionResultMetadataResponse,OperationMetadata> exportPredictionResultMetadataOperationCallable()

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data 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 (AMLClient aMLClient = AMLClient.create()) {
   ExportPredictionResultMetadataRequest request =
       ExportPredictionResultMetadataRequest.newBuilder()
           .setPredictionResult(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .setStructuredMetadataDestination(BigQueryDestination.newBuilder().build())
           .build();
   OperationFuture<ExportPredictionResultMetadataResponse, OperationMetadata> future =
       aMLClient.exportPredictionResultMetadataOperationCallable().futureCall(request);
   // Do something.
   ExportPredictionResultMetadataResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ExportPredictionResultMetadataRequest,ExportPredictionResultMetadataResponse,OperationMetadata>

exportRegisteredPartiesAsync(ExportRegisteredPartiesRequest request)

public final OperationFuture<ExportRegisteredPartiesResponse,OperationMetadata> exportRegisteredPartiesAsync(ExportRegisteredPartiesRequest request)

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   ExportRegisteredPartiesRequest request =
       ExportRegisteredPartiesRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDataset(BigQueryDestination.newBuilder().build())
           .setLineOfBusiness(LineOfBusiness.forNumber(0))
           .build();
   ExportRegisteredPartiesResponse response =
       aMLClient.exportRegisteredPartiesAsync(request).get();
 }
 
Parameter
Name Description
request ExportRegisteredPartiesRequest

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

Returns
Type Description
OperationFuture<ExportRegisteredPartiesResponse,OperationMetadata>

exportRegisteredPartiesAsync(InstanceName name, BigQueryDestination dataset, LineOfBusiness lineOfBusiness)

public final OperationFuture<ExportRegisteredPartiesResponse,OperationMetadata> exportRegisteredPartiesAsync(InstanceName name, BigQueryDestination dataset, LineOfBusiness lineOfBusiness)

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   BigQueryDestination dataset = BigQueryDestination.newBuilder().build();
   LineOfBusiness lineOfBusiness = LineOfBusiness.forNumber(0);
   ExportRegisteredPartiesResponse response =
       aMLClient.exportRegisteredPartiesAsync(name, dataset, lineOfBusiness).get();
 }
 
Parameters
Name Description
name InstanceName

Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}"

dataset BigQueryDestination

Required. The location to output the RegisteredParties.

lineOfBusiness LineOfBusiness

Required. LineOfBusiness to get RegisteredParties from.

Returns
Type Description
OperationFuture<ExportRegisteredPartiesResponse,OperationMetadata>

exportRegisteredPartiesAsync(String name, BigQueryDestination dataset, LineOfBusiness lineOfBusiness)

public final OperationFuture<ExportRegisteredPartiesResponse,OperationMetadata> exportRegisteredPartiesAsync(String name, BigQueryDestination dataset, LineOfBusiness lineOfBusiness)

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   BigQueryDestination dataset = BigQueryDestination.newBuilder().build();
   LineOfBusiness lineOfBusiness = LineOfBusiness.forNumber(0);
   ExportRegisteredPartiesResponse response =
       aMLClient.exportRegisteredPartiesAsync(name, dataset, lineOfBusiness).get();
 }
 
Parameters
Name Description
name String

Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}"

dataset BigQueryDestination

Required. The location to output the RegisteredParties.

lineOfBusiness LineOfBusiness

Required. LineOfBusiness to get RegisteredParties from.

Returns
Type Description
OperationFuture<ExportRegisteredPartiesResponse,OperationMetadata>

exportRegisteredPartiesCallable()

public final UnaryCallable<ExportRegisteredPartiesRequest,Operation> exportRegisteredPartiesCallable()

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   ExportRegisteredPartiesRequest request =
       ExportRegisteredPartiesRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDataset(BigQueryDestination.newBuilder().build())
           .setLineOfBusiness(LineOfBusiness.forNumber(0))
           .build();
   ApiFuture<Operation> future = aMLClient.exportRegisteredPartiesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ExportRegisteredPartiesRequest,Operation>

exportRegisteredPartiesOperationCallable()

public final OperationCallable<ExportRegisteredPartiesRequest,ExportRegisteredPartiesResponse,OperationMetadata> exportRegisteredPartiesOperationCallable()

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   ExportRegisteredPartiesRequest request =
       ExportRegisteredPartiesRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDataset(BigQueryDestination.newBuilder().build())
           .setLineOfBusiness(LineOfBusiness.forNumber(0))
           .build();
   OperationFuture<ExportRegisteredPartiesResponse, OperationMetadata> future =
       aMLClient.exportRegisteredPartiesOperationCallable().futureCall(request);
   // Do something.
   ExportRegisteredPartiesResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ExportRegisteredPartiesRequest,ExportRegisteredPartiesResponse,OperationMetadata>

getBacktestResult(BacktestResultName name)

public final BacktestResult getBacktestResult(BacktestResultName name)

Gets a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   BacktestResultName name =
       BacktestResultName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]");
   BacktestResult response = aMLClient.getBacktestResult(name);
 }
 
Parameter
Name Description
name BacktestResultName

Required. The resource name of the BacktestResult

Returns
Type Description
BacktestResult

getBacktestResult(GetBacktestResultRequest request)

public final BacktestResult getBacktestResult(GetBacktestResultRequest request)

Gets a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetBacktestResultRequest request =
       GetBacktestResultRequest.newBuilder()
           .setName(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .build();
   BacktestResult response = aMLClient.getBacktestResult(request);
 }
 
Parameter
Name Description
request GetBacktestResultRequest

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

Returns
Type Description
BacktestResult

getBacktestResult(String name)

public final BacktestResult getBacktestResult(String name)

Gets a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       BacktestResultName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
           .toString();
   BacktestResult response = aMLClient.getBacktestResult(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the BacktestResult

Returns
Type Description
BacktestResult

getBacktestResultCallable()

public final UnaryCallable<GetBacktestResultRequest,BacktestResult> getBacktestResultCallable()

Gets a BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetBacktestResultRequest request =
       GetBacktestResultRequest.newBuilder()
           .setName(
               BacktestResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[BACKTEST_RESULT]")
                   .toString())
           .build();
   ApiFuture<BacktestResult> future = aMLClient.getBacktestResultCallable().futureCall(request);
   // Do something.
   BacktestResult response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetBacktestResultRequest,BacktestResult>

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 (AMLClient aMLClient = AMLClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[DATASET]");
   Dataset response = aMLClient.getDataset(name);
 }
 
Parameter
Name Description
name DatasetName

Required. The resource name of the Dataset

Returns
Type Description
Dataset

getDataset(GetDatasetRequest request)

public final Dataset getDataset(GetDatasetRequest request)

Gets a dataset.

Sample code:


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

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

Returns
Type Description
Dataset

getDataset(String name)

public final Dataset getDataset(String name)

Gets a dataset.

Sample code:


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

Required. The resource name of the Dataset

Returns
Type Description
Dataset

getDatasetCallable()

public final UnaryCallable<GetDatasetRequest,Dataset> getDatasetCallable()

Gets a dataset.

Sample code:


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

getEngineConfig(EngineConfigName name)

public final EngineConfig getEngineConfig(EngineConfigName name)

Gets an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   EngineConfigName name =
       EngineConfigName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]");
   EngineConfig response = aMLClient.getEngineConfig(name);
 }
 
Parameter
Name Description
name EngineConfigName

Required. The resource name of the EngineConfig

Returns
Type Description
EngineConfig

getEngineConfig(GetEngineConfigRequest request)

public final EngineConfig getEngineConfig(GetEngineConfigRequest request)

Gets an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetEngineConfigRequest request =
       GetEngineConfigRequest.newBuilder()
           .setName(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .build();
   EngineConfig response = aMLClient.getEngineConfig(request);
 }
 
Parameter
Name Description
request GetEngineConfigRequest

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

Returns
Type Description
EngineConfig

getEngineConfig(String name)

public final EngineConfig getEngineConfig(String name)

Gets an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       EngineConfigName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
           .toString();
   EngineConfig response = aMLClient.getEngineConfig(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the EngineConfig

Returns
Type Description
EngineConfig

getEngineConfigCallable()

public final UnaryCallable<GetEngineConfigRequest,EngineConfig> getEngineConfigCallable()

Gets an engine config.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetEngineConfigRequest request =
       GetEngineConfigRequest.newBuilder()
           .setName(
               EngineConfigName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_CONFIG]")
                   .toString())
           .build();
   ApiFuture<EngineConfig> future = aMLClient.getEngineConfigCallable().futureCall(request);
   // Do something.
   EngineConfig response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEngineConfigRequest,EngineConfig>

getEngineVersion(EngineVersionName name)

public final EngineVersion getEngineVersion(EngineVersionName name)

Gets a single EngineVersion.

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 (AMLClient aMLClient = AMLClient.create()) {
   EngineVersionName name =
       EngineVersionName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_VERSION]");
   EngineVersion response = aMLClient.getEngineVersion(name);
 }
 
Parameter
Name Description
name EngineVersionName

Required. The resource name of the EngineVersion

Returns
Type Description
EngineVersion

getEngineVersion(GetEngineVersionRequest request)

public final EngineVersion getEngineVersion(GetEngineVersionRequest request)

Gets a single EngineVersion.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetEngineVersionRequest request =
       GetEngineVersionRequest.newBuilder()
           .setName(
               EngineVersionName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_VERSION]")
                   .toString())
           .build();
   EngineVersion response = aMLClient.getEngineVersion(request);
 }
 
Parameter
Name Description
request GetEngineVersionRequest

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

Returns
Type Description
EngineVersion

getEngineVersion(String name)

public final EngineVersion getEngineVersion(String name)

Gets a single EngineVersion.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       EngineVersionName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_VERSION]")
           .toString();
   EngineVersion response = aMLClient.getEngineVersion(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the EngineVersion

Returns
Type Description
EngineVersion

getEngineVersionCallable()

public final UnaryCallable<GetEngineVersionRequest,EngineVersion> getEngineVersionCallable()

Gets a single EngineVersion.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetEngineVersionRequest request =
       GetEngineVersionRequest.newBuilder()
           .setName(
               EngineVersionName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[ENGINE_VERSION]")
                   .toString())
           .build();
   ApiFuture<EngineVersion> future = aMLClient.getEngineVersionCallable().futureCall(request);
   // Do something.
   EngineVersion response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEngineVersionRequest,EngineVersion>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type Description
OperationsClient

getInstance(GetInstanceRequest request)

public final Instance getInstance(GetInstanceRequest request)

Gets an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = aMLClient.getInstance(request);
 }
 
Parameter
Name Description
request GetInstanceRequest

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

Returns
Type Description
Instance

getInstance(InstanceName name)

public final Instance getInstance(InstanceName name)

Gets an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = aMLClient.getInstance(name);
 }
 
Parameter
Name Description
name InstanceName

Required. The resource name of the Instance.

Returns
Type Description
Instance

getInstance(String name)

public final Instance getInstance(String name)

Gets an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = aMLClient.getInstance(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the Instance.

Returns
Type Description
Instance

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets an instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future = aMLClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetInstanceRequest,Instance>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = aMLClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

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

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = aMLClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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 (AMLClient aMLClient = AMLClient.create()) {
   GetModelRequest request =
       GetModelRequest.newBuilder()
           .setName(
               ModelName.of("[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[MODEL]").toString())
           .build();
   Model response = aMLClient.getModel(request);
 }
 
Parameter
Name Description
request GetModelRequest

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

Returns
Type Description
Model

getModel(ModelName name)

public final Model getModel(ModelName name)

Gets a model.

Sample code:


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

Required. The resource name of the Model

Returns
Type Description
Model

getModel(String name)

public final Model getModel(String name)

Gets a model.

Sample code:


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

Required. The resource name of the Model

Returns
Type Description
Model

getModelCallable()

public final UnaryCallable<GetModelRequest,Model> getModelCallable()

Gets a model.

Sample code:


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

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getPredictionResult(GetPredictionResultRequest request)

public final PredictionResult getPredictionResult(GetPredictionResultRequest request)

Gets a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetPredictionResultRequest request =
       GetPredictionResultRequest.newBuilder()
           .setName(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .build();
   PredictionResult response = aMLClient.getPredictionResult(request);
 }
 
Parameter
Name Description
request GetPredictionResultRequest

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

Returns
Type Description
PredictionResult

getPredictionResult(PredictionResultName name)

public final PredictionResult getPredictionResult(PredictionResultName name)

Gets a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   PredictionResultName name =
       PredictionResultName.of(
           "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]");
   PredictionResult response = aMLClient.getPredictionResult(name);
 }
 
Parameter
Name Description
name PredictionResultName

Required. The resource name of the PredictionResult

Returns
Type Description
PredictionResult

getPredictionResult(String name)

public final PredictionResult getPredictionResult(String name)

Gets a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name =
       PredictionResultName.of(
               "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
           .toString();
   PredictionResult response = aMLClient.getPredictionResult(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the PredictionResult

Returns
Type Description
PredictionResult

getPredictionResultCallable()

public final UnaryCallable<GetPredictionResultRequest,PredictionResult> getPredictionResultCallable()

Gets a PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   GetPredictionResultRequest request =
       GetPredictionResultRequest.newBuilder()
           .setName(
               PredictionResultName.of(
                       "[PROJECT_NUM]", "[LOCATION]", "[INSTANCE]", "[PREDICTION_RESULT]")
                   .toString())
           .build();
   ApiFuture<PredictionResult> future =
       aMLClient.getPredictionResultCallable().futureCall(request);
   // Do something.
   PredictionResult response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetPredictionResultRequest,PredictionResult>

getSettings()

public final AMLSettings getSettings()
Returns
Type Description
AMLSettings

getStub()

public AMLStub getStub()
Returns
Type Description
AMLStub

importRegisteredPartiesAsync(ImportRegisteredPartiesRequest request)

public final OperationFuture<ImportRegisteredPartiesResponse,OperationMetadata> importRegisteredPartiesAsync(ImportRegisteredPartiesRequest request)

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   ImportRegisteredPartiesRequest request =
       ImportRegisteredPartiesRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .addAllPartyTables(new ArrayList<String>())
           .setValidateOnly(true)
           .setLineOfBusiness(LineOfBusiness.forNumber(0))
           .build();
   ImportRegisteredPartiesResponse response =
       aMLClient.importRegisteredPartiesAsync(request).get();
 }
 
Parameter
Name Description
request ImportRegisteredPartiesRequest

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

Returns
Type Description
OperationFuture<ImportRegisteredPartiesResponse,OperationMetadata>

importRegisteredPartiesAsync(InstanceName name, ImportRegisteredPartiesRequest.UpdateMode mode, LineOfBusiness lineOfBusiness, List<String> partyTables)

public final OperationFuture<ImportRegisteredPartiesResponse,OperationMetadata> importRegisteredPartiesAsync(InstanceName name, ImportRegisteredPartiesRequest.UpdateMode mode, LineOfBusiness lineOfBusiness, List<String> partyTables)

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   ImportRegisteredPartiesRequest.UpdateMode mode =
       ImportRegisteredPartiesRequest.UpdateMode.forNumber(0);
   LineOfBusiness lineOfBusiness = LineOfBusiness.forNumber(0);
   List<String> partyTables = new ArrayList<>();
   ImportRegisteredPartiesResponse response =
       aMLClient.importRegisteredPartiesAsync(name, mode, lineOfBusiness, partyTables).get();
 }
 
Parameters
Name Description
name InstanceName

Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}"

mode ImportRegisteredPartiesRequest.UpdateMode

Required. Mode of the request.

lineOfBusiness LineOfBusiness

Required. LineOfBusiness for the specified registered parties.

partyTables List<String>

Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: "bq://{project}.{bqDatasetID}.{bqTableID}" Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time

Returns
Type Description
OperationFuture<ImportRegisteredPartiesResponse,OperationMetadata>

importRegisteredPartiesAsync(String name, ImportRegisteredPartiesRequest.UpdateMode mode, LineOfBusiness lineOfBusiness, List<String> partyTables)

public final OperationFuture<ImportRegisteredPartiesResponse,OperationMetadata> importRegisteredPartiesAsync(String name, ImportRegisteredPartiesRequest.UpdateMode mode, LineOfBusiness lineOfBusiness, List<String> partyTables)

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   ImportRegisteredPartiesRequest.UpdateMode mode =
       ImportRegisteredPartiesRequest.UpdateMode.forNumber(0);
   LineOfBusiness lineOfBusiness = LineOfBusiness.forNumber(0);
   List<String> partyTables = new ArrayList<>();
   ImportRegisteredPartiesResponse response =
       aMLClient.importRegisteredPartiesAsync(name, mode, lineOfBusiness, partyTables).get();
 }
 
Parameters
Name Description
name String

Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}"

mode ImportRegisteredPartiesRequest.UpdateMode

Required. Mode of the request.

lineOfBusiness LineOfBusiness

Required. LineOfBusiness for the specified registered parties.

partyTables List<String>

Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: "bq://{project}.{bqDatasetID}.{bqTableID}" Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time

Returns
Type Description
OperationFuture<ImportRegisteredPartiesResponse,OperationMetadata>

importRegisteredPartiesCallable()

public final UnaryCallable<ImportRegisteredPartiesRequest,Operation> importRegisteredPartiesCallable()

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   ImportRegisteredPartiesRequest request =
       ImportRegisteredPartiesRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .addAllPartyTables(new ArrayList<String>())
           .setValidateOnly(true)
           .setLineOfBusiness(LineOfBusiness.forNumber(0))
           .build();
   ApiFuture<Operation> future = aMLClient.importRegisteredPartiesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ImportRegisteredPartiesRequest,Operation>

importRegisteredPartiesOperationCallable()

public final OperationCallable<ImportRegisteredPartiesRequest,ImportRegisteredPartiesResponse,OperationMetadata> importRegisteredPartiesOperationCallable()

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

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 (AMLClient aMLClient = AMLClient.create()) {
   ImportRegisteredPartiesRequest request =
       ImportRegisteredPartiesRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .addAllPartyTables(new ArrayList<String>())
           .setValidateOnly(true)
           .setLineOfBusiness(LineOfBusiness.forNumber(0))
           .build();
   OperationFuture<ImportRegisteredPartiesResponse, OperationMetadata> future =
       aMLClient.importRegisteredPartiesOperationCallable().futureCall(request);
   // Do something.
   ImportRegisteredPartiesResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ImportRegisteredPartiesRequest,ImportRegisteredPartiesResponse,OperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listBacktestResults(InstanceName parent)

public final AMLClient.ListBacktestResultsPagedResponse listBacktestResults(InstanceName parent)

List BacktestResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (BacktestResult element : aMLClient.listBacktestResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent InstanceName

Required. The parent of the BacktestResult is the Instance.

Returns
Type Description
AMLClient.ListBacktestResultsPagedResponse

listBacktestResults(ListBacktestResultsRequest request)

public final AMLClient.ListBacktestResultsPagedResponse listBacktestResults(ListBacktestResultsRequest request)

List BacktestResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListBacktestResultsRequest request =
       ListBacktestResultsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (BacktestResult element : aMLClient.listBacktestResults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListBacktestResultsRequest

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

Returns
Type Description
AMLClient.ListBacktestResultsPagedResponse

listBacktestResults(String parent)

public final AMLClient.ListBacktestResultsPagedResponse listBacktestResults(String parent)

List BacktestResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (BacktestResult element : aMLClient.listBacktestResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the BacktestResult is the Instance.

Returns
Type Description
AMLClient.ListBacktestResultsPagedResponse

listBacktestResultsCallable()

public final UnaryCallable<ListBacktestResultsRequest,ListBacktestResultsResponse> listBacktestResultsCallable()

List BacktestResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListBacktestResultsRequest request =
       ListBacktestResultsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListBacktestResultsResponse response =
         aMLClient.listBacktestResultsCallable().call(request);
     for (BacktestResult element : response.getBacktestResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListBacktestResultsRequest,ListBacktestResultsResponse>

listBacktestResultsPagedCallable()

public final UnaryCallable<ListBacktestResultsRequest,AMLClient.ListBacktestResultsPagedResponse> listBacktestResultsPagedCallable()

List BacktestResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListBacktestResultsRequest request =
       ListBacktestResultsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<BacktestResult> future =
       aMLClient.listBacktestResultsPagedCallable().futureCall(request);
   // Do something.
   for (BacktestResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListBacktestResultsRequest,ListBacktestResultsPagedResponse>

listDatasets(InstanceName parent)

public final AMLClient.ListDatasetsPagedResponse listDatasets(InstanceName parent)

Lists datasets.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (Dataset element : aMLClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent InstanceName

Required. The parent of the Dataset is the Instance.

Returns
Type Description
AMLClient.ListDatasetsPagedResponse

listDatasets(ListDatasetsRequest request)

public final AMLClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)

Lists datasets.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Dataset element : aMLClient.listDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDatasetsRequest

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

Returns
Type Description
AMLClient.ListDatasetsPagedResponse

listDatasets(String parent)

public final AMLClient.ListDatasetsPagedResponse listDatasets(String parent)

Lists datasets.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (Dataset element : aMLClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the Dataset is the Instance.

Returns
Type Description
AMLClient.ListDatasetsPagedResponse

listDatasetsCallable()

public final UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> listDatasetsCallable()

Lists datasets.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDatasetsResponse response = aMLClient.listDatasetsCallable().call(request);
     for (Dataset element : response.getDatasetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>

listDatasetsPagedCallable()

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

Lists datasets.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Dataset> future = aMLClient.listDatasetsPagedCallable().futureCall(request);
   // Do something.
   for (Dataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDatasetsRequest,ListDatasetsPagedResponse>

listEngineConfigs(InstanceName parent)

public final AMLClient.ListEngineConfigsPagedResponse listEngineConfigs(InstanceName parent)

Lists engine configs.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (EngineConfig element : aMLClient.listEngineConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent InstanceName

Required. The parent of the EngineConfig is the Instance.

Returns
Type Description
AMLClient.ListEngineConfigsPagedResponse

listEngineConfigs(ListEngineConfigsRequest request)

public final AMLClient.ListEngineConfigsPagedResponse listEngineConfigs(ListEngineConfigsRequest request)

Lists engine configs.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListEngineConfigsRequest request =
       ListEngineConfigsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EngineConfig element : aMLClient.listEngineConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEngineConfigsRequest

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

Returns
Type Description
AMLClient.ListEngineConfigsPagedResponse

listEngineConfigs(String parent)

public final AMLClient.ListEngineConfigsPagedResponse listEngineConfigs(String parent)

Lists engine configs.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (EngineConfig element : aMLClient.listEngineConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the EngineConfig is the Instance.

Returns
Type Description
AMLClient.ListEngineConfigsPagedResponse

listEngineConfigsCallable()

public final UnaryCallable<ListEngineConfigsRequest,ListEngineConfigsResponse> listEngineConfigsCallable()

Lists engine configs.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListEngineConfigsRequest request =
       ListEngineConfigsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEngineConfigsResponse response = aMLClient.listEngineConfigsCallable().call(request);
     for (EngineConfig element : response.getEngineConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEngineConfigsRequest,ListEngineConfigsResponse>

listEngineConfigsPagedCallable()

public final UnaryCallable<ListEngineConfigsRequest,AMLClient.ListEngineConfigsPagedResponse> listEngineConfigsPagedCallable()

Lists engine configs.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListEngineConfigsRequest request =
       ListEngineConfigsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EngineConfig> future =
       aMLClient.listEngineConfigsPagedCallable().futureCall(request);
   // Do something.
   for (EngineConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEngineConfigsRequest,ListEngineConfigsPagedResponse>

listEngineVersions(InstanceName parent)

public final AMLClient.ListEngineVersionsPagedResponse listEngineVersions(InstanceName parent)

Lists EngineVersions for given location.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (EngineVersion element : aMLClient.listEngineVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent InstanceName

Required. The parent of the EngineVersion is the Instance.

Returns
Type Description
AMLClient.ListEngineVersionsPagedResponse

listEngineVersions(ListEngineVersionsRequest request)

public final AMLClient.ListEngineVersionsPagedResponse listEngineVersions(ListEngineVersionsRequest request)

Lists EngineVersions for given location.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListEngineVersionsRequest request =
       ListEngineVersionsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EngineVersion element : aMLClient.listEngineVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEngineVersionsRequest

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

Returns
Type Description
AMLClient.ListEngineVersionsPagedResponse

listEngineVersions(String parent)

public final AMLClient.ListEngineVersionsPagedResponse listEngineVersions(String parent)

Lists EngineVersions for given location.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (EngineVersion element : aMLClient.listEngineVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the EngineVersion is the Instance.

Returns
Type Description
AMLClient.ListEngineVersionsPagedResponse

listEngineVersionsCallable()

public final UnaryCallable<ListEngineVersionsRequest,ListEngineVersionsResponse> listEngineVersionsCallable()

Lists EngineVersions for given location.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListEngineVersionsRequest request =
       ListEngineVersionsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEngineVersionsResponse response = aMLClient.listEngineVersionsCallable().call(request);
     for (EngineVersion element : response.getEngineVersionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEngineVersionsRequest,ListEngineVersionsResponse>

listEngineVersionsPagedCallable()

public final UnaryCallable<ListEngineVersionsRequest,AMLClient.ListEngineVersionsPagedResponse> listEngineVersionsPagedCallable()

Lists EngineVersions for given location.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListEngineVersionsRequest request =
       ListEngineVersionsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EngineVersion> future =
       aMLClient.listEngineVersionsPagedCallable().futureCall(request);
   // Do something.
   for (EngineVersion element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEngineVersionsRequest,ListEngineVersionsPagedResponse>

listInstances(ListInstancesRequest request)

public final AMLClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)

Lists instances.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Instance element : aMLClient.listInstances(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListInstancesRequest

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

Returns
Type Description
AMLClient.ListInstancesPagedResponse

listInstances(LocationName parent)

public final AMLClient.ListInstancesPagedResponse listInstances(LocationName parent)

Lists instances.

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 (AMLClient aMLClient = AMLClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : aMLClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

Returns
Type Description
AMLClient.ListInstancesPagedResponse

listInstances(String parent)

public final AMLClient.ListInstancesPagedResponse listInstances(String parent)

Lists instances.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Instance element : aMLClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

Returns
Type Description
AMLClient.ListInstancesPagedResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

Lists instances.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListInstancesResponse response = aMLClient.listInstancesCallable().call(request);
     for (Instance element : response.getInstancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListInstancesRequest,ListInstancesResponse>

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRequest,AMLClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists instances.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Instance> future = aMLClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse>

listLocations(ListLocationsRequest request)

public final AMLClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : aMLClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

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

Returns
Type Description
AMLClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = aMLClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,AMLClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = aMLClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listModels(InstanceName parent)

public final AMLClient.ListModelsPagedResponse listModels(InstanceName 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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (Model element : aMLClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent InstanceName

Required. The parent of the Model is the Instance.

Returns
Type Description
AMLClient.ListModelsPagedResponse

listModels(ListModelsRequest request)

public final AMLClient.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 (AMLClient aMLClient = AMLClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Model element : aMLClient.listModels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListModelsRequest

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

Returns
Type Description
AMLClient.ListModelsPagedResponse

listModels(String parent)

public final AMLClient.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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (Model element : aMLClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the Model is the Instance.

Returns
Type Description
AMLClient.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 (AMLClient aMLClient = AMLClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListModelsResponse response = aMLClient.listModelsCallable().call(request);
     for (Model element : response.getModelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListModelsRequest,ListModelsResponse>

listModelsPagedCallable()

public final UnaryCallable<ListModelsRequest,AMLClient.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 (AMLClient aMLClient = AMLClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Model> future = aMLClient.listModelsPagedCallable().futureCall(request);
   // Do something.
   for (Model element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListModelsRequest,ListModelsPagedResponse>

listPredictionResults(InstanceName parent)

public final AMLClient.ListPredictionResultsPagedResponse listPredictionResults(InstanceName parent)

List PredictionResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (PredictionResult element : aMLClient.listPredictionResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent InstanceName

Required. The parent of the PredictionResult is the Instance.

Returns
Type Description
AMLClient.ListPredictionResultsPagedResponse

listPredictionResults(ListPredictionResultsRequest request)

public final AMLClient.ListPredictionResultsPagedResponse listPredictionResults(ListPredictionResultsRequest request)

List PredictionResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListPredictionResultsRequest request =
       ListPredictionResultsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (PredictionResult element : aMLClient.listPredictionResults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPredictionResultsRequest

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

Returns
Type Description
AMLClient.ListPredictionResultsPagedResponse

listPredictionResults(String parent)

public final AMLClient.ListPredictionResultsPagedResponse listPredictionResults(String parent)

List PredictionResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (PredictionResult element : aMLClient.listPredictionResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the PredictionResult is the Instance.

Returns
Type Description
AMLClient.ListPredictionResultsPagedResponse

listPredictionResultsCallable()

public final UnaryCallable<ListPredictionResultsRequest,ListPredictionResultsResponse> listPredictionResultsCallable()

List PredictionResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListPredictionResultsRequest request =
       ListPredictionResultsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListPredictionResultsResponse response =
         aMLClient.listPredictionResultsCallable().call(request);
     for (PredictionResult element : response.getPredictionResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPredictionResultsRequest,ListPredictionResultsResponse>

listPredictionResultsPagedCallable()

public final UnaryCallable<ListPredictionResultsRequest,AMLClient.ListPredictionResultsPagedResponse> listPredictionResultsPagedCallable()

List PredictionResults.

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 (AMLClient aMLClient = AMLClient.create()) {
   ListPredictionResultsRequest request =
       ListPredictionResultsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<PredictionResult> future =
       aMLClient.listPredictionResultsPagedCallable().futureCall(request);
   // Do something.
   for (PredictionResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPredictionResultsRequest,ListPredictionResultsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBacktestResultAsync(BacktestResult backtestResult, FieldMask updateMask)

public final OperationFuture<BacktestResult,OperationMetadata> updateBacktestResultAsync(BacktestResult backtestResult, FieldMask updateMask)

Updates the parameters of a single BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   BacktestResult backtestResult = BacktestResult.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BacktestResult response =
       aMLClient.updateBacktestResultAsync(backtestResult, updateMask).get();
 }
 
Parameters
Name Description
backtestResult BacktestResult

Required. The new value of the BacktestResult fields that will be updated according to the update_mask.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the BacktestResult resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<BacktestResult,OperationMetadata>

updateBacktestResultAsync(UpdateBacktestResultRequest request)

public final OperationFuture<BacktestResult,OperationMetadata> updateBacktestResultAsync(UpdateBacktestResultRequest request)

Updates the parameters of a single BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateBacktestResultRequest request =
       UpdateBacktestResultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBacktestResult(BacktestResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   BacktestResult response = aMLClient.updateBacktestResultAsync(request).get();
 }
 
Parameter
Name Description
request UpdateBacktestResultRequest

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

Returns
Type Description
OperationFuture<BacktestResult,OperationMetadata>

updateBacktestResultCallable()

public final UnaryCallable<UpdateBacktestResultRequest,Operation> updateBacktestResultCallable()

Updates the parameters of a single BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateBacktestResultRequest request =
       UpdateBacktestResultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBacktestResult(BacktestResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.updateBacktestResultCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateBacktestResultRequest,Operation>

updateBacktestResultOperationCallable()

public final OperationCallable<UpdateBacktestResultRequest,BacktestResult,OperationMetadata> updateBacktestResultOperationCallable()

Updates the parameters of a single BacktestResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateBacktestResultRequest request =
       UpdateBacktestResultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setBacktestResult(BacktestResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<BacktestResult, OperationMetadata> future =
       aMLClient.updateBacktestResultOperationCallable().futureCall(request);
   // Do something.
   BacktestResult response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateBacktestResultRequest,BacktestResult,OperationMetadata>

updateDatasetAsync(Dataset dataset, FieldMask updateMask)

public final OperationFuture<Dataset,OperationMetadata> updateDatasetAsync(Dataset dataset, FieldMask updateMask)

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   Dataset dataset = Dataset.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Dataset response = aMLClient.updateDatasetAsync(dataset, updateMask).get();
 }
 
Parameters
Name Description
dataset Dataset

Required. The new value of the dataset fields that will be updated according to the update_mask.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Dataset resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<Dataset,OperationMetadata>

updateDatasetAsync(UpdateDatasetRequest request)

public final OperationFuture<Dataset,OperationMetadata> updateDatasetAsync(UpdateDatasetRequest request)

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDataset(Dataset.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Dataset response = aMLClient.updateDatasetAsync(request).get();
 }
 
Parameter
Name Description
request UpdateDatasetRequest

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

Returns
Type Description
OperationFuture<Dataset,OperationMetadata>

updateDatasetCallable()

public final UnaryCallable<UpdateDatasetRequest,Operation> updateDatasetCallable()

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDataset(Dataset.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.updateDatasetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDatasetRequest,Operation>

updateDatasetOperationCallable()

public final OperationCallable<UpdateDatasetRequest,Dataset,OperationMetadata> updateDatasetOperationCallable()

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDataset(Dataset.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Dataset, OperationMetadata> future =
       aMLClient.updateDatasetOperationCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateDatasetRequest,Dataset,OperationMetadata>

updateEngineConfigAsync(EngineConfig engineConfig, FieldMask updateMask)

public final OperationFuture<EngineConfig,OperationMetadata> updateEngineConfigAsync(EngineConfig engineConfig, FieldMask updateMask)

Updates the parameters of a single EngineConfig.

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 (AMLClient aMLClient = AMLClient.create()) {
   EngineConfig engineConfig = EngineConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EngineConfig response = aMLClient.updateEngineConfigAsync(engineConfig, updateMask).get();
 }
 
Parameters
Name Description
engineConfig EngineConfig

Required. The new value of the EngineConfig fields that will be updated according to the update_mask.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the EngineConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<EngineConfig,OperationMetadata>

updateEngineConfigAsync(UpdateEngineConfigRequest request)

public final OperationFuture<EngineConfig,OperationMetadata> updateEngineConfigAsync(UpdateEngineConfigRequest request)

Updates the parameters of a single EngineConfig.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateEngineConfigRequest request =
       UpdateEngineConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEngineConfig(EngineConfig.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   EngineConfig response = aMLClient.updateEngineConfigAsync(request).get();
 }
 
Parameter
Name Description
request UpdateEngineConfigRequest

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

Returns
Type Description
OperationFuture<EngineConfig,OperationMetadata>

updateEngineConfigCallable()

public final UnaryCallable<UpdateEngineConfigRequest,Operation> updateEngineConfigCallable()

Updates the parameters of a single EngineConfig.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateEngineConfigRequest request =
       UpdateEngineConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEngineConfig(EngineConfig.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.updateEngineConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEngineConfigRequest,Operation>

updateEngineConfigOperationCallable()

public final OperationCallable<UpdateEngineConfigRequest,EngineConfig,OperationMetadata> updateEngineConfigOperationCallable()

Updates the parameters of a single EngineConfig.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateEngineConfigRequest request =
       UpdateEngineConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEngineConfig(EngineConfig.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<EngineConfig, OperationMetadata> future =
       aMLClient.updateEngineConfigOperationCallable().futureCall(request);
   // Do something.
   EngineConfig response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateEngineConfigRequest,EngineConfig,OperationMetadata>

updateInstanceAsync(Instance instance, FieldMask updateMask)

public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, FieldMask updateMask)

Updates the parameters of a single Instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   Instance instance = Instance.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Instance response = aMLClient.updateInstanceAsync(instance, updateMask).get();
 }
 
Parameters
Name Description
instance Instance

Required. The new value of the instance fields that will be updated according to the update_mask

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

updateInstanceAsync(UpdateInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request)

Updates the parameters of a single Instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Instance response = aMLClient.updateInstanceAsync(request).get();
 }
 
Parameter
Name Description
request UpdateInstanceRequest

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

Returns
Type Description
OperationFuture<Instance,OperationMetadata>

updateInstanceCallable()

public final UnaryCallable<UpdateInstanceRequest,Operation> updateInstanceCallable()

Updates the parameters of a single Instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.updateInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateInstanceRequest,Operation>

updateInstanceOperationCallable()

public final OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationCallable()

Updates the parameters of a single Instance.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInstance(Instance.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       aMLClient.updateInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata>

updateModelAsync(Model model, FieldMask updateMask)

public final OperationFuture<Model,OperationMetadata> updateModelAsync(Model model, FieldMask updateMask)

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   Model model = Model.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Model response = aMLClient.updateModelAsync(model, updateMask).get();
 }
 
Parameters
Name Description
model Model

Required. The new value of the Model fields that will be updated according to the update_mask.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Model resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<Model,OperationMetadata>

updateModelAsync(UpdateModelRequest request)

public final OperationFuture<Model,OperationMetadata> updateModelAsync(UpdateModelRequest request)

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateModelRequest request =
       UpdateModelRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setModel(Model.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Model response = aMLClient.updateModelAsync(request).get();
 }
 
Parameter
Name Description
request UpdateModelRequest

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

Returns
Type Description
OperationFuture<Model,OperationMetadata>

updateModelCallable()

public final UnaryCallable<UpdateModelRequest,Operation> updateModelCallable()

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateModelRequest request =
       UpdateModelRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setModel(Model.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.updateModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateModelRequest,Operation>

updateModelOperationCallable()

public final OperationCallable<UpdateModelRequest,Model,OperationMetadata> updateModelOperationCallable()

Updates the parameters of a single 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 (AMLClient aMLClient = AMLClient.create()) {
   UpdateModelRequest request =
       UpdateModelRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setModel(Model.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Model, OperationMetadata> future =
       aMLClient.updateModelOperationCallable().futureCall(request);
   // Do something.
   Model response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateModelRequest,Model,OperationMetadata>

updatePredictionResultAsync(PredictionResult predictionResult, FieldMask updateMask)

public final OperationFuture<PredictionResult,OperationMetadata> updatePredictionResultAsync(PredictionResult predictionResult, FieldMask updateMask)

Updates the parameters of a single PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   PredictionResult predictionResult = PredictionResult.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PredictionResult response =
       aMLClient.updatePredictionResultAsync(predictionResult, updateMask).get();
 }
 
Parameters
Name Description
predictionResult PredictionResult

Required. The new value of the PredictionResult fields that will be updated according to the update_mask.

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the PredictionResult resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type Description
OperationFuture<PredictionResult,OperationMetadata>

updatePredictionResultAsync(UpdatePredictionResultRequest request)

public final OperationFuture<PredictionResult,OperationMetadata> updatePredictionResultAsync(UpdatePredictionResultRequest request)

Updates the parameters of a single PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdatePredictionResultRequest request =
       UpdatePredictionResultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setPredictionResult(PredictionResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   PredictionResult response = aMLClient.updatePredictionResultAsync(request).get();
 }
 
Parameter
Name Description
request UpdatePredictionResultRequest

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

Returns
Type Description
OperationFuture<PredictionResult,OperationMetadata>

updatePredictionResultCallable()

public final UnaryCallable<UpdatePredictionResultRequest,Operation> updatePredictionResultCallable()

Updates the parameters of a single PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdatePredictionResultRequest request =
       UpdatePredictionResultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setPredictionResult(PredictionResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = aMLClient.updatePredictionResultCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdatePredictionResultRequest,Operation>

updatePredictionResultOperationCallable()

public final OperationCallable<UpdatePredictionResultRequest,PredictionResult,OperationMetadata> updatePredictionResultOperationCallable()

Updates the parameters of a single PredictionResult.

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 (AMLClient aMLClient = AMLClient.create()) {
   UpdatePredictionResultRequest request =
       UpdatePredictionResultRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setPredictionResult(PredictionResult.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<PredictionResult, OperationMetadata> future =
       aMLClient.updatePredictionResultOperationCallable().futureCall(request);
   // Do something.
   PredictionResult response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdatePredictionResultRequest,PredictionResult,OperationMetadata>