ModelServiceClient (Google Cloud Vertex AI 3.0.0 API)

java.lang.Object
- com.google.cloud.aiplatform.v1beta1.ModelServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@BetaApi
 @Generated(value="by gapic-generator-java")
public class ModelServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: A service for managing Vertex AI's machine learning Models.
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Model response = modelServiceClient.getModel(name);
 }
 
```
Note: close() needs to be called on the ModelServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ModelServiceSettings to create(). For example:
To customize credentials:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ModelServiceSettings modelServiceSettings =
     ModelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
 
```
To customize the endpoint:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ModelServiceSettings modelServiceSettings =
     ModelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
 
```
Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ModelServiceClient.ListLocationsFixedSizeCollection`
`static class`	`ModelServiceClient.ListLocationsPage`
`static class`	`ModelServiceClient.ListLocationsPagedResponse`
`static class`	`ModelServiceClient.ListModelEvaluationsFixedSizeCollection`
`static class`	`ModelServiceClient.ListModelEvaluationSlicesFixedSizeCollection`
`static class`	`ModelServiceClient.ListModelEvaluationSlicesPage`
`static class`	`ModelServiceClient.ListModelEvaluationSlicesPagedResponse`
`static class`	`ModelServiceClient.ListModelEvaluationsPage`
`static class`	`ModelServiceClient.ListModelEvaluationsPagedResponse`
`static class`	`ModelServiceClient.ListModelsFixedSizeCollection`
`static class`	`ModelServiceClient.ListModelsPage`
`static class`	`ModelServiceClient.ListModelsPagedResponse`
`static class`	`ModelServiceClient.ListModelVersionsFixedSizeCollection`
`static class`	`ModelServiceClient.ListModelVersionsPage`
`static class`	`ModelServiceClient.ListModelVersionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ModelServiceClient(ModelServiceSettings settings)` Constructs an instance of ModelServiceClient, using the given settings.
`protected`	`ModelServiceClient(ModelServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`BatchImportModelEvaluationSlicesResponse`	`batchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request)` Imports a list of externally generated ModelEvaluationSlice.
`BatchImportModelEvaluationSlicesResponse`	`batchImportModelEvaluationSlices(ModelEvaluationName parent, List<ModelEvaluationSlice> modelEvaluationSlices)` Imports a list of externally generated ModelEvaluationSlice.
`BatchImportModelEvaluationSlicesResponse`	`batchImportModelEvaluationSlices(String parent, List<ModelEvaluationSlice> modelEvaluationSlices)` Imports a list of externally generated ModelEvaluationSlice.
`com.google.api.gax.rpc.UnaryCallable<BatchImportModelEvaluationSlicesRequest,BatchImportModelEvaluationSlicesResponse>`	`batchImportModelEvaluationSlicesCallable()` Imports a list of externally generated ModelEvaluationSlice.
`void`	`close()`
`static ModelServiceClient`	`create()` Constructs an instance of ModelServiceClient with default settings.
`static ModelServiceClient`	`create(ModelServiceSettings settings)` Constructs an instance of ModelServiceClient, using the given settings.
`static ModelServiceClient`	`create(ModelServiceStub stub)` Constructs an instance of ModelServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelAsync(DeleteModelRequest request)` Deletes a Model.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelAsync(ModelName name)` Deletes a Model.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelAsync(String name)` Deletes a Model.
`com.google.api.gax.rpc.UnaryCallable<DeleteModelRequest,com.google.longrunning.Operation>`	`deleteModelCallable()` Deletes a Model.
`com.google.api.gax.rpc.OperationCallable<DeleteModelRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelOperationCallable()` Deletes a Model.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelVersionAsync(DeleteModelVersionRequest request)` Deletes a Model version.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelVersionAsync(ModelName name)` Deletes a Model version.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelVersionAsync(String name)` Deletes a Model version.
`com.google.api.gax.rpc.UnaryCallable<DeleteModelVersionRequest,com.google.longrunning.Operation>`	`deleteModelVersionCallable()` Deletes a Model version.
`com.google.api.gax.rpc.OperationCallable<DeleteModelVersionRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deleteModelVersionOperationCallable()` Deletes a Model version.
`com.google.api.gax.longrunning.OperationFuture<ExportModelResponse,ExportModelOperationMetadata>`	`exportModelAsync(ExportModelRequest request)` Exports a trained, exportable Model to a location specified by the user.
`com.google.api.gax.longrunning.OperationFuture<ExportModelResponse,ExportModelOperationMetadata>`	`exportModelAsync(ModelName name, ExportModelRequest.OutputConfig outputConfig)` Exports a trained, exportable Model to a location specified by the user.
`com.google.api.gax.longrunning.OperationFuture<ExportModelResponse,ExportModelOperationMetadata>`	`exportModelAsync(String name, ExportModelRequest.OutputConfig outputConfig)` Exports a trained, exportable Model to a location specified by the user.
`com.google.api.gax.rpc.UnaryCallable<ExportModelRequest,com.google.longrunning.Operation>`	`exportModelCallable()` Exports a trained, exportable Model to a location specified by the user.
`com.google.api.gax.rpc.OperationCallable<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata>`	`exportModelOperationCallable()` Exports a trained, exportable Model to a location specified by the user.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`Model`	`getModel(GetModelRequest request)` Gets a Model.
`Model`	`getModel(ModelName name)` Gets a Model.
`Model`	`getModel(String name)` Gets a Model.
`com.google.api.gax.rpc.UnaryCallable<GetModelRequest,Model>`	`getModelCallable()` Gets a Model.
`ModelEvaluation`	`getModelEvaluation(GetModelEvaluationRequest request)` Gets a ModelEvaluation.
`ModelEvaluation`	`getModelEvaluation(ModelEvaluationName name)` Gets a ModelEvaluation.
`ModelEvaluation`	`getModelEvaluation(String name)` Gets a ModelEvaluation.
`com.google.api.gax.rpc.UnaryCallable<GetModelEvaluationRequest,ModelEvaluation>`	`getModelEvaluationCallable()` Gets a ModelEvaluation.
`ModelEvaluationSlice`	`getModelEvaluationSlice(GetModelEvaluationSliceRequest request)` Gets a ModelEvaluationSlice.
`ModelEvaluationSlice`	`getModelEvaluationSlice(ModelEvaluationSliceName name)` Gets a ModelEvaluationSlice.
`ModelEvaluationSlice`	`getModelEvaluationSlice(String name)` Gets a ModelEvaluationSlice.
`com.google.api.gax.rpc.UnaryCallable<GetModelEvaluationSliceRequest,ModelEvaluationSlice>`	`getModelEvaluationSliceCallable()` Gets a ModelEvaluationSlice.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`ModelServiceSettings`	`getSettings()`
`ModelServiceStub`	`getStub()`
`ModelEvaluation`	`importModelEvaluation(ImportModelEvaluationRequest request)` Imports an externally generated ModelEvaluation.
`ModelEvaluation`	`importModelEvaluation(ModelName parent, ModelEvaluation modelEvaluation)` Imports an externally generated ModelEvaluation.
`ModelEvaluation`	`importModelEvaluation(String parent, ModelEvaluation modelEvaluation)` Imports an externally generated ModelEvaluation.
`com.google.api.gax.rpc.UnaryCallable<ImportModelEvaluationRequest,ModelEvaluation>`	`importModelEvaluationCallable()` Imports an externally generated ModelEvaluation.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ModelServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ModelServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ModelServiceClient.ListModelEvaluationsPagedResponse`	`listModelEvaluations(ListModelEvaluationsRequest request)` Lists ModelEvaluations in a Model.
`ModelServiceClient.ListModelEvaluationsPagedResponse`	`listModelEvaluations(ModelName parent)` Lists ModelEvaluations in a Model.
`ModelServiceClient.ListModelEvaluationsPagedResponse`	`listModelEvaluations(String parent)` Lists ModelEvaluations in a Model.
`com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsResponse>`	`listModelEvaluationsCallable()` Lists ModelEvaluations in a Model.
`ModelServiceClient.ListModelEvaluationSlicesPagedResponse`	`listModelEvaluationSlices(ListModelEvaluationSlicesRequest request)` Lists ModelEvaluationSlices in a ModelEvaluation.
`ModelServiceClient.ListModelEvaluationSlicesPagedResponse`	`listModelEvaluationSlices(ModelEvaluationName parent)` Lists ModelEvaluationSlices in a ModelEvaluation.
`ModelServiceClient.ListModelEvaluationSlicesPagedResponse`	`listModelEvaluationSlices(String parent)` Lists ModelEvaluationSlices in a ModelEvaluation.
`com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse>`	`listModelEvaluationSlicesCallable()` Lists ModelEvaluationSlices in a ModelEvaluation.
`com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationSlicesRequest,ModelServiceClient.ListModelEvaluationSlicesPagedResponse>`	`listModelEvaluationSlicesPagedCallable()` Lists ModelEvaluationSlices in a ModelEvaluation.
`com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,ModelServiceClient.ListModelEvaluationsPagedResponse>`	`listModelEvaluationsPagedCallable()` Lists ModelEvaluations in a Model.
`ModelServiceClient.ListModelsPagedResponse`	`listModels(ListModelsRequest request)` Lists Models in a Location.
`ModelServiceClient.ListModelsPagedResponse`	`listModels(LocationName parent)` Lists Models in a Location.
`ModelServiceClient.ListModelsPagedResponse`	`listModels(String parent)` Lists Models in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,ListModelsResponse>`	`listModelsCallable()` Lists Models in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,ModelServiceClient.ListModelsPagedResponse>`	`listModelsPagedCallable()` Lists Models in a Location.
`ModelServiceClient.ListModelVersionsPagedResponse`	`listModelVersions(ListModelVersionsRequest request)` Lists versions of the specified model.
`ModelServiceClient.ListModelVersionsPagedResponse`	`listModelVersions(ModelName name)` Lists versions of the specified model.
`ModelServiceClient.ListModelVersionsPagedResponse`	`listModelVersions(String name)` Lists versions of the specified model.
`com.google.api.gax.rpc.UnaryCallable<ListModelVersionsRequest,ListModelVersionsResponse>`	`listModelVersionsCallable()` Lists versions of the specified model.
`com.google.api.gax.rpc.UnaryCallable<ListModelVersionsRequest,ModelServiceClient.ListModelVersionsPagedResponse>`	`listModelVersionsPagedCallable()` Lists versions of the specified model.
`Model`	`mergeVersionAliases(MergeVersionAliasesRequest request)` Merges a set of aliases for a Model version.
`Model`	`mergeVersionAliases(ModelName name, List<String> versionAliases)` Merges a set of aliases for a Model version.
`Model`	`mergeVersionAliases(String name, List<String> versionAliases)` Merges a set of aliases for a Model version.
`com.google.api.gax.rpc.UnaryCallable<MergeVersionAliasesRequest,Model>`	`mergeVersionAliasesCallable()` Merges a set of aliases for a Model version.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata>`	`updateExplanationDatasetAsync(ModelName model)` Incrementally update the dataset used for an examples model.
`com.google.api.gax.longrunning.OperationFuture<UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata>`	`updateExplanationDatasetAsync(String model)` Incrementally update the dataset used for an examples model.
`com.google.api.gax.longrunning.OperationFuture<UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata>`	`updateExplanationDatasetAsync(UpdateExplanationDatasetRequest request)` Incrementally update the dataset used for an examples model.
`com.google.api.gax.rpc.UnaryCallable<UpdateExplanationDatasetRequest,com.google.longrunning.Operation>`	`updateExplanationDatasetCallable()` Incrementally update the dataset used for an examples model.
`com.google.api.gax.rpc.OperationCallable<UpdateExplanationDatasetRequest,UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata>`	`updateExplanationDatasetOperationCallable()` Incrementally update the dataset used for an examples model.
`Model`	`updateModel(Model model, com.google.protobuf.FieldMask updateMask)` Updates a Model.
`Model`	`updateModel(UpdateModelRequest request)` Updates a Model.
`com.google.api.gax.rpc.UnaryCallable<UpdateModelRequest,Model>`	`updateModelCallable()` Updates a Model.
`com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata>`	`uploadModelAsync(LocationName parent, Model model)` Uploads a Model artifact into Vertex AI.
`com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata>`	`uploadModelAsync(String parent, Model model)` Uploads a Model artifact into Vertex AI.
`com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata>`	`uploadModelAsync(UploadModelRequest request)` Uploads a Model artifact into Vertex AI.
`com.google.api.gax.rpc.UnaryCallable<UploadModelRequest,com.google.longrunning.Operation>`	`uploadModelCallable()` Uploads a Model artifact into Vertex AI.
`com.google.api.gax.rpc.OperationCallable<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata>`	`uploadModelOperationCallable()` Uploads a Model artifact into Vertex AI.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ModelServiceClient
```
protected ModelServiceClient(ModelServiceSettings settings)
                      throws IOException
```
  Constructs an instance of ModelServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- ModelServiceClient
```
protected ModelServiceClient(ModelServiceStub stub)
```

Method Detail

create

public static final ModelServiceClient create()
                                       throws IOException

Constructs an instance of ModelServiceClient with default settings.

Throws:: IOException

create
```
public static final ModelServiceClient create(ModelServiceSettings settings)
                                       throws IOException
```
Constructs an instance of ModelServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final ModelServiceClient create(ModelServiceStub stub)
```
Constructs an instance of ModelServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ModelServiceSettings).

getSettings

public final ModelServiceSettings getSettings()

getStub
```
public ModelServiceStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

uploadModelAsync

public final com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata> uploadModelAsync(LocationName parent,
                                                                                                                               Model model)

Uploads a Model artifact into Vertex AI.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Model model = Model.newBuilder().build();
   UploadModelResponse response = modelServiceClient.uploadModelAsync(parent, model).get();
 }

Parameters:: parent - Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`; model - Required. The Model to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

uploadModelAsync

public final com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata> uploadModelAsync(String parent,
                                                                                                                               Model model)

Uploads a Model artifact into Vertex AI.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Model model = Model.newBuilder().build();
   UploadModelResponse response = modelServiceClient.uploadModelAsync(parent, model).get();
 }

Parameters:: parent - Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`; model - Required. The Model to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

uploadModelAsync

public final com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata> uploadModelAsync(UploadModelRequest request)

Uploads a Model artifact into Vertex AI.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   UploadModelRequest request =
       UploadModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setParentModel("parentModel998431903")
           .setModelId("modelId1226956324")
           .setModel(Model.newBuilder().build())
           .build();
   UploadModelResponse response = modelServiceClient.uploadModelAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

uploadModelOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata> uploadModelOperationCallable()

Uploads a Model artifact into Vertex AI.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   UploadModelRequest request =
       UploadModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setParentModel("parentModel998431903")
           .setModelId("modelId1226956324")
           .setModel(Model.newBuilder().build())
           .build();
   OperationFuture<UploadModelResponse, UploadModelOperationMetadata> future =
       modelServiceClient.uploadModelOperationCallable().futureCall(request);
   // Do something.
   UploadModelResponse response = future.get();
 }

uploadModelCallable

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

Uploads a Model artifact into Vertex AI.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   UploadModelRequest request =
       UploadModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setParentModel("parentModel998431903")
           .setModelId("modelId1226956324")
           .setModel(Model.newBuilder().build())
           .build();
   ApiFuture<Operation> future = modelServiceClient.uploadModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

getModel
```
public final Model getModel(ModelName name)
```
Gets a Model.
Sample code:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
   Model response = modelServiceClient.getModel(name);
 }
 
```
Parameters:

name - Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.

Throws:

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

getModel
```
public final Model getModel(String name)
```
Gets a Model.
Sample code:
```
 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
   Model response = modelServiceClient.getModel(name);
 }
 
```
Parameters:

name - Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}`
In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.

Throws:

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

getModel

public final Model getModel(GetModelRequest request)

Gets a Model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   GetModelRequest request =
       GetModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   Model response = modelServiceClient.getModel(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getModelCallable

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

Gets a Model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   GetModelRequest request =
       GetModelRequest.newBuilder()
           .setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
           .build();
   ApiFuture<Model> future = modelServiceClient.getModelCallable().futureCall(request);
   // Do something.
   Model response = future.get();
 }

listModels

public final ModelServiceClient.ListModelsPagedResponse listModels(LocationName parent)

Lists Models in a Location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Model element : modelServiceClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listModels

public final ModelServiceClient.ListModelsPagedResponse listModels(String parent)

Lists Models in a Location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Model element : modelServiceClient.listModels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listModels

public final ModelServiceClient.ListModelsPagedResponse listModels(ListModelsRequest request)

Lists Models in a Location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (Model element : modelServiceClient.listModels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listModelsPagedCallable

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

Lists Models in a Location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Model> future = modelServiceClient.listModelsPagedCallable().futureCall(request);
   // Do something.
   for (Model element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listModelsCallable

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

Lists Models in a Location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
   ListModelsRequest request =
       ListModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListModelsResponse response = modelServiceClient.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;
     }
   }
 }