@Generated(value="by gapic-generator-java") public class ModelServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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 (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().
| Method | Description | Method Variants |
|---|---|---|
UploadModel |
Uploads a Model artifact into Vertex AI. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetModel |
Gets a Model. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListModels |
Lists Models in a Location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListModelVersions |
Lists versions of the specified model. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateModel |
Updates a Model. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateExplanationDataset |
Incrementally update the dataset used for an examples model. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteModel |
Deletes a Model. A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteModelVersion |
Deletes a Model version. Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
MergeVersionAliases |
Merges a set of aliases for a Model version. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ExportModel |
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats]. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CopyModel |
Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ImportModelEvaluation |
Imports an externally generated ModelEvaluation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchImportModelEvaluationSlices |
Imports a list of externally generated ModelEvaluationSlice. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchImportEvaluatedAnnotations |
Imports a list of externally generated EvaluatedAnnotations. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetModelEvaluation |
Gets a ModelEvaluation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListModelEvaluations |
Lists ModelEvaluations in a Model. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetModelEvaluationSlice |
Gets a ModelEvaluationSlice. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListModelEvaluationSlices |
Lists ModelEvaluationSlices in a ModelEvaluation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ModelServiceSettings modelServiceSettings =
ModelServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
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
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.
| 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 |
| Modifier | Constructor and Description |
|---|---|
protected |
ModelServiceClient(ModelServiceSettings settings)
Constructs an instance of ModelServiceClient, using the given settings.
|
protected |
ModelServiceClient(ModelServiceStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
BatchImportEvaluatedAnnotationsResponse |
batchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request)
Imports a list of externally generated EvaluatedAnnotations.
|
BatchImportEvaluatedAnnotationsResponse |
batchImportEvaluatedAnnotations(ModelEvaluationSliceName parent,
List<EvaluatedAnnotation> evaluatedAnnotations)
Imports a list of externally generated EvaluatedAnnotations.
|
BatchImportEvaluatedAnnotationsResponse |
batchImportEvaluatedAnnotations(String parent,
List<EvaluatedAnnotation> evaluatedAnnotations)
Imports a list of externally generated EvaluatedAnnotations.
|
com.google.api.gax.rpc.UnaryCallable<BatchImportEvaluatedAnnotationsRequest,BatchImportEvaluatedAnnotationsResponse> |
batchImportEvaluatedAnnotationsCallable()
Imports a list of externally generated EvaluatedAnnotations.
|
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() |
com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> |
copyModelAsync(CopyModelRequest request)
Copies an already existing Vertex AI Model into the specified Location.
|
com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> |
copyModelAsync(LocationName parent,
ModelName sourceModel)
Copies an already existing Vertex AI Model into the specified Location.
|
com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> |
copyModelAsync(LocationName parent,
String sourceModel)
Copies an already existing Vertex AI Model into the specified Location.
|
com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> |
copyModelAsync(String parent,
ModelName sourceModel)
Copies an already existing Vertex AI Model into the specified Location.
|
com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> |
copyModelAsync(String parent,
String sourceModel)
Copies an already existing Vertex AI Model into the specified Location.
|
com.google.api.gax.rpc.UnaryCallable<CopyModelRequest,com.google.longrunning.Operation> |
copyModelCallable()
Copies an already existing Vertex AI Model into the specified Location.
|
com.google.api.gax.rpc.OperationCallable<CopyModelRequest,CopyModelResponse,CopyModelOperationMetadata> |
copyModelOperationCallable()
Copies an already existing Vertex AI Model into the specified Location.
|
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.
|
protected ModelServiceClient(ModelServiceSettings settings) throws IOException
IOExceptionprotected ModelServiceClient(ModelServiceStub stub)
public static final ModelServiceClient create() throws IOException
IOExceptionpublic static final ModelServiceClient create(ModelServiceSettings settings) throws IOException
IOExceptionpublic static final ModelServiceClient create(ModelServiceStub stub)
public final ModelServiceSettings getSettings()
public ModelServiceStub getStub()
public final com.google.longrunning.OperationsClient getOperationsClient()
public final com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata> uploadModelAsync(LocationName parent, Model 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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Model model = Model.newBuilder().build();
UploadModelResponse response = modelServiceClient.uploadModelAsync(parent, model).get();
}
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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata> uploadModelAsync(String parent, Model 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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Model model = Model.newBuilder().build();
UploadModelResponse response = modelServiceClient.uploadModelAsync(parent, model).get();
}
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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<UploadModelResponse,UploadModelOperationMetadata> uploadModelAsync(UploadModelRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UploadModelRequest request =
UploadModelRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setParentModel("parentModel998431903")
.setModelId("modelId1226956324")
.setModel(Model.newBuilder().build())
.setServiceAccount("serviceAccount1079137720")
.build();
UploadModelResponse response = modelServiceClient.uploadModelAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata> uploadModelOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UploadModelRequest request =
UploadModelRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setParentModel("parentModel998431903")
.setModelId("modelId1226956324")
.setModel(Model.newBuilder().build())
.setServiceAccount("serviceAccount1079137720")
.build();
OperationFuture<UploadModelResponse, UploadModelOperationMetadata> future =
modelServiceClient.uploadModelOperationCallable().futureCall(request);
// Do something.
UploadModelResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<UploadModelRequest,com.google.longrunning.Operation> uploadModelCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UploadModelRequest request =
UploadModelRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setParentModel("parentModel998431903")
.setModelId("modelId1226956324")
.setModel(Model.newBuilder().build())
.setServiceAccount("serviceAccount1079137720")
.build();
ApiFuture<Operation> future = modelServiceClient.uploadModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final Model getModel(ModelName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
Model response = modelServiceClient.getModel(name);
}
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.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final Model getModel(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
Model response = modelServiceClient.getModel(name);
}
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.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final Model getModel(GetModelRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelRequest request =
GetModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
Model response = modelServiceClient.getModel(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetModelRequest,Model> getModelCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
public final ModelServiceClient.ListModelsPagedResponse listModels(LocationName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Model element : modelServiceClient.listModels(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the Location to list the Models from. Format:
`projects/{project}/locations/{location}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelsPagedResponse listModels(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Model element : modelServiceClient.listModels(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the Location to list the Models from. Format:
`projects/{project}/locations/{location}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelsPagedResponse listModels(ListModelsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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())
.setOrderBy("orderBy-1207110587")
.build();
for (Model element : modelServiceClient.listModels(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,ModelServiceClient.ListModelsPagedResponse> listModelsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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())
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Model> future = modelServiceClient.listModelsPagedCallable().futureCall(request);
// Do something.
for (Model element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListModelsRequest,ListModelsResponse> listModelsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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())
.setOrderBy("orderBy-1207110587")
.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;
}
}
}
public final ModelServiceClient.ListModelVersionsPagedResponse listModelVersions(ModelName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
for (Model element : modelServiceClient.listModelVersions(name).iterateAll()) {
// doThingsWith(element);
}
}
name - Required. The name of the model to list versions for.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelVersionsPagedResponse listModelVersions(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
for (Model element : modelServiceClient.listModelVersions(name).iterateAll()) {
// doThingsWith(element);
}
}
name - Required. The name of the model to list versions for.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelVersionsPagedResponse listModelVersions(ListModelVersionsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelVersionsRequest request =
ListModelVersionsRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
for (Model element : modelServiceClient.listModelVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListModelVersionsRequest,ModelServiceClient.ListModelVersionsPagedResponse> listModelVersionsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelVersionsRequest request =
ListModelVersionsRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Model> future =
modelServiceClient.listModelVersionsPagedCallable().futureCall(request);
// Do something.
for (Model element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListModelVersionsRequest,ListModelVersionsResponse> listModelVersionsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelVersionsRequest request =
ListModelVersionsRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListModelVersionsResponse response =
modelServiceClient.listModelVersionsCallable().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;
}
}
}
public final Model updateModel(Model model, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
Model model = Model.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Model response = modelServiceClient.updateModel(model, updateMask);
}
model - Required. The Model which replaces the resource on the server. When Model
Versioning is enabled, the model.name will be used to determine whether to update the model
or model version. 1. model.name with the @ value, e.g. models/123@1,
refers to a version specific update. 2. model.name without the @ value, e.g.
models/123, refers to a model update. 3. model.name with @-, e.g.
models/123@-, refers to a model update. 4. Supported model fields: display_name,
description; supported version-specific fields: version_description. Labels are supported
in both scenarios. Both the model labels and the version labels are merged when a model is
returned. When updating labels, if the request is for model-specific update, model label
gets updated. Otherwise, version labels get updated. 5. A model name or model version name
fields update mismatch will cause a precondition error. 6. One request cannot update both
the model and the version fields. You must update them separately.updateMask - Required. The update mask applies to the resource. For the `FieldMask`
definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].com.google.api.gax.rpc.ApiException - if the remote call failspublic final Model updateModel(UpdateModelRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateModelRequest request =
UpdateModelRequest.newBuilder()
.setModel(Model.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Model response = modelServiceClient.updateModel(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateModelRequest,Model> updateModelCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateModelRequest request =
UpdateModelRequest.newBuilder()
.setModel(Model.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Model> future = modelServiceClient.updateModelCallable().futureCall(request);
// Do something.
Model response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata> updateExplanationDatasetAsync(ModelName 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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName model = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
UpdateExplanationDatasetResponse response =
modelServiceClient.updateExplanationDatasetAsync(model).get();
}
model - Required. The resource name of the Model to update. Format:
`projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata> updateExplanationDatasetAsync(String 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 (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String model = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
UpdateExplanationDatasetResponse response =
modelServiceClient.updateExplanationDatasetAsync(model).get();
}
model - Required. The resource name of the Model to update. Format:
`projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata> updateExplanationDatasetAsync(UpdateExplanationDatasetRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateExplanationDatasetRequest request =
UpdateExplanationDatasetRequest.newBuilder()
.setModel(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setExamples(Examples.newBuilder().build())
.build();
UpdateExplanationDatasetResponse response =
modelServiceClient.updateExplanationDatasetAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<UpdateExplanationDatasetRequest,UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata> updateExplanationDatasetOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateExplanationDatasetRequest request =
UpdateExplanationDatasetRequest.newBuilder()
.setModel(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setExamples(Examples.newBuilder().build())
.build();
OperationFuture<UpdateExplanationDatasetResponse, UpdateExplanationDatasetOperationMetadata>
future =
modelServiceClient.updateExplanationDatasetOperationCallable().futureCall(request);
// Do something.
UpdateExplanationDatasetResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<UpdateExplanationDatasetRequest,com.google.longrunning.Operation> updateExplanationDatasetCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
UpdateExplanationDatasetRequest request =
UpdateExplanationDatasetRequest.newBuilder()
.setModel(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setExamples(Examples.newBuilder().build())
.build();
ApiFuture<Operation> future =
modelServiceClient.updateExplanationDatasetCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelAsync(ModelName name)
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
modelServiceClient.deleteModelAsync(name).get();
}
name - Required. The name of the Model resource to be deleted. Format:
`projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelAsync(String name)
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
modelServiceClient.deleteModelAsync(name).get();
}
name - Required. The name of the Model resource to be deleted. Format:
`projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelAsync(DeleteModelRequest request)
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelRequest request =
DeleteModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
modelServiceClient.deleteModelAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<DeleteModelRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelOperationCallable()
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelRequest request =
DeleteModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
modelServiceClient.deleteModelOperationCallable().futureCall(request);
// Do something.
future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<DeleteModelRequest,com.google.longrunning.Operation> deleteModelCallable()
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelRequest request =
DeleteModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
ApiFuture<Operation> future = modelServiceClient.deleteModelCallable().futureCall(request);
// Do something.
future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelVersionAsync(ModelName name)
Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
modelServiceClient.deleteModelVersionAsync(name).get();
}
name - Required. The name of the model version to be deleted, with a version ID explicitly
included.
Example: `projects/{project}/locations/{location}/models/{model}@1234`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelVersionAsync(String name)
Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
modelServiceClient.deleteModelVersionAsync(name).get();
}
name - Required. The name of the model version to be deleted, with a version ID explicitly
included.
Example: `projects/{project}/locations/{location}/models/{model}@1234`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelVersionAsync(DeleteModelVersionRequest request)
Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelVersionRequest request =
DeleteModelVersionRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
modelServiceClient.deleteModelVersionAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<DeleteModelVersionRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelVersionOperationCallable()
Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelVersionRequest request =
DeleteModelVersionRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
modelServiceClient.deleteModelVersionOperationCallable().futureCall(request);
// Do something.
future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<DeleteModelVersionRequest,com.google.longrunning.Operation> deleteModelVersionCallable()
Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
DeleteModelVersionRequest request =
DeleteModelVersionRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.build();
ApiFuture<Operation> future =
modelServiceClient.deleteModelVersionCallable().futureCall(request);
// Do something.
future.get();
}
public final Model mergeVersionAliases(ModelName name, List<String> versionAliases)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
List<String> versionAliases = new ArrayList<>();
Model response = modelServiceClient.mergeVersionAliases(name, versionAliases);
}
name - Required. The name of the model version to merge aliases, with a version ID
explicitly included.
Example: `projects/{project}/locations/{location}/models/{model}@1234`
versionAliases - Required. The set of version aliases to merge. The alias should be at
most 128 characters, and match `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`. Add the `-` prefix to
an alias means removing that alias from the version. `-` is NOT counted in the 128
characters. Example: `-golden` means removing the `golden` alias from the version.
There is NO ordering in aliases, which means 1) The aliases returned from GetModel API might not have the exactly same order from this MergeVersionAliases API. 2) Adding and deleting the same alias in the request is not recommended, and the 2 operations will be cancelled out.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final Model mergeVersionAliases(String name, List<String> versionAliases)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
List<String> versionAliases = new ArrayList<>();
Model response = modelServiceClient.mergeVersionAliases(name, versionAliases);
}
name - Required. The name of the model version to merge aliases, with a version ID
explicitly included.
Example: `projects/{project}/locations/{location}/models/{model}@1234`
versionAliases - Required. The set of version aliases to merge. The alias should be at
most 128 characters, and match `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`. Add the `-` prefix to
an alias means removing that alias from the version. `-` is NOT counted in the 128
characters. Example: `-golden` means removing the `golden` alias from the version.
There is NO ordering in aliases, which means 1) The aliases returned from GetModel API might not have the exactly same order from this MergeVersionAliases API. 2) Adding and deleting the same alias in the request is not recommended, and the 2 operations will be cancelled out.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final Model mergeVersionAliases(MergeVersionAliasesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
MergeVersionAliasesRequest request =
MergeVersionAliasesRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.addAllVersionAliases(new ArrayList<String>())
.build();
Model response = modelServiceClient.mergeVersionAliases(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<MergeVersionAliasesRequest,Model> mergeVersionAliasesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
MergeVersionAliasesRequest request =
MergeVersionAliasesRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.addAllVersionAliases(new ArrayList<String>())
.build();
ApiFuture<Model> future =
modelServiceClient.mergeVersionAliasesCallable().futureCall(request);
// Do something.
Model response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<ExportModelResponse,ExportModelOperationMetadata> exportModelAsync(ModelName name, ExportModelRequest.OutputConfig outputConfig)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
ExportModelRequest.OutputConfig outputConfig =
ExportModelRequest.OutputConfig.newBuilder().build();
ExportModelResponse response = modelServiceClient.exportModelAsync(name, outputConfig).get();
}
name - Required. The resource name of the Model to export. The resource name may contain
version id or version alias to specify the version, if no version is specified, the default
version will be exported.outputConfig - Required. The desired output location and configuration.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<ExportModelResponse,ExportModelOperationMetadata> exportModelAsync(String name, ExportModelRequest.OutputConfig outputConfig)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
ExportModelRequest.OutputConfig outputConfig =
ExportModelRequest.OutputConfig.newBuilder().build();
ExportModelResponse response = modelServiceClient.exportModelAsync(name, outputConfig).get();
}
name - Required. The resource name of the Model to export. The resource name may contain
version id or version alias to specify the version, if no version is specified, the default
version will be exported.outputConfig - Required. The desired output location and configuration.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<ExportModelResponse,ExportModelOperationMetadata> exportModelAsync(ExportModelRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ExportModelRequest request =
ExportModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setOutputConfig(ExportModelRequest.OutputConfig.newBuilder().build())
.build();
ExportModelResponse response = modelServiceClient.exportModelAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata> exportModelOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ExportModelRequest request =
ExportModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setOutputConfig(ExportModelRequest.OutputConfig.newBuilder().build())
.build();
OperationFuture<ExportModelResponse, ExportModelOperationMetadata> future =
modelServiceClient.exportModelOperationCallable().futureCall(request);
// Do something.
ExportModelResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<ExportModelRequest,com.google.longrunning.Operation> exportModelCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ExportModelRequest request =
ExportModelRequest.newBuilder()
.setName(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setOutputConfig(ExportModelRequest.OutputConfig.newBuilder().build())
.build();
ApiFuture<Operation> future = modelServiceClient.exportModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> copyModelAsync(LocationName parent, ModelName sourceModel)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
ModelName sourceModel = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
CopyModelResponse response = modelServiceClient.copyModelAsync(parent, sourceModel).get();
}
parent - Required. The resource name of the Location into which to copy the Model. Format:
`projects/{project}/locations/{location}`sourceModel - Required. The resource name of the Model to copy. That Model must be in the
same Project. Format: `projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> copyModelAsync(LocationName parent, String sourceModel)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
String sourceModel = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
CopyModelResponse response = modelServiceClient.copyModelAsync(parent, sourceModel).get();
}
parent - Required. The resource name of the Location into which to copy the Model. Format:
`projects/{project}/locations/{location}`sourceModel - Required. The resource name of the Model to copy. That Model must be in the
same Project. Format: `projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> copyModelAsync(String parent, ModelName sourceModel)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
ModelName sourceModel = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
CopyModelResponse response = modelServiceClient.copyModelAsync(parent, sourceModel).get();
}
parent - Required. The resource name of the Location into which to copy the Model. Format:
`projects/{project}/locations/{location}`sourceModel - Required. The resource name of the Model to copy. That Model must be in the
same Project. Format: `projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> copyModelAsync(String parent, String sourceModel)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String sourceModel = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
CopyModelResponse response = modelServiceClient.copyModelAsync(parent, sourceModel).get();
}
parent - Required. The resource name of the Location into which to copy the Model. Format:
`projects/{project}/locations/{location}`sourceModel - Required. The resource name of the Model to copy. That Model must be in the
same Project. Format: `projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<CopyModelResponse,CopyModelOperationMetadata> copyModelAsync(CopyModelRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CopyModelRequest request =
CopyModelRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSourceModel(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setEncryptionSpec(EncryptionSpec.newBuilder().build())
.build();
CopyModelResponse response = modelServiceClient.copyModelAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<CopyModelRequest,CopyModelResponse,CopyModelOperationMetadata> copyModelOperationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CopyModelRequest request =
CopyModelRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSourceModel(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setEncryptionSpec(EncryptionSpec.newBuilder().build())
.build();
OperationFuture<CopyModelResponse, CopyModelOperationMetadata> future =
modelServiceClient.copyModelOperationCallable().futureCall(request);
// Do something.
CopyModelResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<CopyModelRequest,com.google.longrunning.Operation> copyModelCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
CopyModelRequest request =
CopyModelRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSourceModel(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setEncryptionSpec(EncryptionSpec.newBuilder().build())
.build();
ApiFuture<Operation> future = modelServiceClient.copyModelCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final ModelEvaluation importModelEvaluation(ModelName parent, ModelEvaluation modelEvaluation)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
ModelEvaluation modelEvaluation = ModelEvaluation.newBuilder().build();
ModelEvaluation response = modelServiceClient.importModelEvaluation(parent, modelEvaluation);
}
parent - Required. The name of the parent model resource. Format:
`projects/{project}/locations/{location}/models/{model}`modelEvaluation - Required. Model evaluation resource to be imported.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelEvaluation importModelEvaluation(String parent, ModelEvaluation modelEvaluation)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
ModelEvaluation modelEvaluation = ModelEvaluation.newBuilder().build();
ModelEvaluation response = modelServiceClient.importModelEvaluation(parent, modelEvaluation);
}
parent - Required. The name of the parent model resource. Format:
`projects/{project}/locations/{location}/models/{model}`modelEvaluation - Required. Model evaluation resource to be imported.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelEvaluation importModelEvaluation(ImportModelEvaluationRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ImportModelEvaluationRequest request =
ImportModelEvaluationRequest.newBuilder()
.setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setModelEvaluation(ModelEvaluation.newBuilder().build())
.build();
ModelEvaluation response = modelServiceClient.importModelEvaluation(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ImportModelEvaluationRequest,ModelEvaluation> importModelEvaluationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ImportModelEvaluationRequest request =
ImportModelEvaluationRequest.newBuilder()
.setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setModelEvaluation(ModelEvaluation.newBuilder().build())
.build();
ApiFuture<ModelEvaluation> future =
modelServiceClient.importModelEvaluationCallable().futureCall(request);
// Do something.
ModelEvaluation response = future.get();
}
public final BatchImportModelEvaluationSlicesResponse batchImportModelEvaluationSlices(ModelEvaluationName parent, List<ModelEvaluationSlice> modelEvaluationSlices)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelEvaluationName parent =
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]");
List<ModelEvaluationSlice> modelEvaluationSlices = new ArrayList<>();
BatchImportModelEvaluationSlicesResponse response =
modelServiceClient.batchImportModelEvaluationSlices(parent, modelEvaluationSlices);
}
parent - Required. The name of the parent ModelEvaluation resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`modelEvaluationSlices - Required. Model evaluation slice resource to be imported.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BatchImportModelEvaluationSlicesResponse batchImportModelEvaluationSlices(String parent, List<ModelEvaluationSlice> modelEvaluationSlices)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent =
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]").toString();
List<ModelEvaluationSlice> modelEvaluationSlices = new ArrayList<>();
BatchImportModelEvaluationSlicesResponse response =
modelServiceClient.batchImportModelEvaluationSlices(parent, modelEvaluationSlices);
}
parent - Required. The name of the parent ModelEvaluation resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`modelEvaluationSlices - Required. Model evaluation slice resource to be imported.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BatchImportModelEvaluationSlicesResponse batchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
BatchImportModelEvaluationSlicesRequest request =
BatchImportModelEvaluationSlicesRequest.newBuilder()
.setParent(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.addAllModelEvaluationSlices(new ArrayList<ModelEvaluationSlice>())
.build();
BatchImportModelEvaluationSlicesResponse response =
modelServiceClient.batchImportModelEvaluationSlices(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<BatchImportModelEvaluationSlicesRequest,BatchImportModelEvaluationSlicesResponse> batchImportModelEvaluationSlicesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
BatchImportModelEvaluationSlicesRequest request =
BatchImportModelEvaluationSlicesRequest.newBuilder()
.setParent(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.addAllModelEvaluationSlices(new ArrayList<ModelEvaluationSlice>())
.build();
ApiFuture<BatchImportModelEvaluationSlicesResponse> future =
modelServiceClient.batchImportModelEvaluationSlicesCallable().futureCall(request);
// Do something.
BatchImportModelEvaluationSlicesResponse response = future.get();
}
public final BatchImportEvaluatedAnnotationsResponse batchImportEvaluatedAnnotations(ModelEvaluationSliceName parent, List<EvaluatedAnnotation> evaluatedAnnotations)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelEvaluationSliceName parent =
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]");
List<EvaluatedAnnotation> evaluatedAnnotations = new ArrayList<>();
BatchImportEvaluatedAnnotationsResponse response =
modelServiceClient.batchImportEvaluatedAnnotations(parent, evaluatedAnnotations);
}
parent - Required. The name of the parent ModelEvaluationSlice resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`evaluatedAnnotations - Required. Evaluated annotations resource to be imported.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BatchImportEvaluatedAnnotationsResponse batchImportEvaluatedAnnotations(String parent, List<EvaluatedAnnotation> evaluatedAnnotations)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent =
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]")
.toString();
List<EvaluatedAnnotation> evaluatedAnnotations = new ArrayList<>();
BatchImportEvaluatedAnnotationsResponse response =
modelServiceClient.batchImportEvaluatedAnnotations(parent, evaluatedAnnotations);
}
parent - Required. The name of the parent ModelEvaluationSlice resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`evaluatedAnnotations - Required. Evaluated annotations resource to be imported.com.google.api.gax.rpc.ApiException - if the remote call failspublic final BatchImportEvaluatedAnnotationsResponse batchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
BatchImportEvaluatedAnnotationsRequest request =
BatchImportEvaluatedAnnotationsRequest.newBuilder()
.setParent(
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]")
.toString())
.addAllEvaluatedAnnotations(new ArrayList<EvaluatedAnnotation>())
.build();
BatchImportEvaluatedAnnotationsResponse response =
modelServiceClient.batchImportEvaluatedAnnotations(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<BatchImportEvaluatedAnnotationsRequest,BatchImportEvaluatedAnnotationsResponse> batchImportEvaluatedAnnotationsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
BatchImportEvaluatedAnnotationsRequest request =
BatchImportEvaluatedAnnotationsRequest.newBuilder()
.setParent(
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]")
.toString())
.addAllEvaluatedAnnotations(new ArrayList<EvaluatedAnnotation>())
.build();
ApiFuture<BatchImportEvaluatedAnnotationsResponse> future =
modelServiceClient.batchImportEvaluatedAnnotationsCallable().futureCall(request);
// Do something.
BatchImportEvaluatedAnnotationsResponse response = future.get();
}
public final ModelEvaluation getModelEvaluation(ModelEvaluationName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelEvaluationName name =
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]");
ModelEvaluation response = modelServiceClient.getModelEvaluation(name);
}
name - Required. The name of the ModelEvaluation resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelEvaluation getModelEvaluation(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name =
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]").toString();
ModelEvaluation response = modelServiceClient.getModelEvaluation(name);
}
name - Required. The name of the ModelEvaluation resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelEvaluation getModelEvaluation(GetModelEvaluationRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelEvaluationRequest request =
GetModelEvaluationRequest.newBuilder()
.setName(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.build();
ModelEvaluation response = modelServiceClient.getModelEvaluation(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetModelEvaluationRequest,ModelEvaluation> getModelEvaluationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelEvaluationRequest request =
GetModelEvaluationRequest.newBuilder()
.setName(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.build();
ApiFuture<ModelEvaluation> future =
modelServiceClient.getModelEvaluationCallable().futureCall(request);
// Do something.
ModelEvaluation response = future.get();
}
public final ModelServiceClient.ListModelEvaluationsPagedResponse listModelEvaluations(ModelName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
for (ModelEvaluation element : modelServiceClient.listModelEvaluations(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the Model to list the ModelEvaluations from.
Format: `projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelEvaluationsPagedResponse listModelEvaluations(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString();
for (ModelEvaluation element : modelServiceClient.listModelEvaluations(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the Model to list the ModelEvaluations from.
Format: `projects/{project}/locations/{location}/models/{model}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelEvaluationsPagedResponse listModelEvaluations(ListModelEvaluationsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelEvaluationsRequest request =
ListModelEvaluationsRequest.newBuilder()
.setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (ModelEvaluation element :
modelServiceClient.listModelEvaluations(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,ModelServiceClient.ListModelEvaluationsPagedResponse> listModelEvaluationsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelEvaluationsRequest request =
ListModelEvaluationsRequest.newBuilder()
.setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<ModelEvaluation> future =
modelServiceClient.listModelEvaluationsPagedCallable().futureCall(request);
// Do something.
for (ModelEvaluation element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationsRequest,ListModelEvaluationsResponse> listModelEvaluationsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelEvaluationsRequest request =
ListModelEvaluationsRequest.newBuilder()
.setParent(ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListModelEvaluationsResponse response =
modelServiceClient.listModelEvaluationsCallable().call(request);
for (ModelEvaluation element : response.getModelEvaluationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final ModelEvaluationSlice getModelEvaluationSlice(ModelEvaluationSliceName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelEvaluationSliceName name =
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]");
ModelEvaluationSlice response = modelServiceClient.getModelEvaluationSlice(name);
}
name - Required. The name of the ModelEvaluationSlice resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelEvaluationSlice getModelEvaluationSlice(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String name =
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]")
.toString();
ModelEvaluationSlice response = modelServiceClient.getModelEvaluationSlice(name);
}
name - Required. The name of the ModelEvaluationSlice resource. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelEvaluationSlice getModelEvaluationSlice(GetModelEvaluationSliceRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelEvaluationSliceRequest request =
GetModelEvaluationSliceRequest.newBuilder()
.setName(
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]")
.toString())
.build();
ModelEvaluationSlice response = modelServiceClient.getModelEvaluationSlice(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetModelEvaluationSliceRequest,ModelEvaluationSlice> getModelEvaluationSliceCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetModelEvaluationSliceRequest request =
GetModelEvaluationSliceRequest.newBuilder()
.setName(
ModelEvaluationSliceName.of(
"[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]", "[SLICE]")
.toString())
.build();
ApiFuture<ModelEvaluationSlice> future =
modelServiceClient.getModelEvaluationSliceCallable().futureCall(request);
// Do something.
ModelEvaluationSlice response = future.get();
}
public final ModelServiceClient.ListModelEvaluationSlicesPagedResponse listModelEvaluationSlices(ModelEvaluationName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelEvaluationName parent =
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]");
for (ModelEvaluationSlice element :
modelServiceClient.listModelEvaluationSlices(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the ModelEvaluation to list the
ModelEvaluationSlices from. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelEvaluationSlicesPagedResponse listModelEvaluationSlices(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
String parent =
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]").toString();
for (ModelEvaluationSlice element :
modelServiceClient.listModelEvaluationSlices(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the ModelEvaluation to list the
ModelEvaluationSlices from. Format:
`projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ModelServiceClient.ListModelEvaluationSlicesPagedResponse listModelEvaluationSlices(ListModelEvaluationSlicesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelEvaluationSlicesRequest request =
ListModelEvaluationSlicesRequest.newBuilder()
.setParent(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (ModelEvaluationSlice element :
modelServiceClient.listModelEvaluationSlices(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationSlicesRequest,ModelServiceClient.ListModelEvaluationSlicesPagedResponse> listModelEvaluationSlicesPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelEvaluationSlicesRequest request =
ListModelEvaluationSlicesRequest.newBuilder()
.setParent(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<ModelEvaluationSlice> future =
modelServiceClient.listModelEvaluationSlicesPagedCallable().futureCall(request);
// Do something.
for (ModelEvaluationSlice element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse> listModelEvaluationSlicesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListModelEvaluationSlicesRequest request =
ListModelEvaluationSlicesRequest.newBuilder()
.setParent(
ModelEvaluationName.of("[PROJECT]", "[LOCATION]", "[MODEL]", "[EVALUATION]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListModelEvaluationSlicesResponse response =
modelServiceClient.listModelEvaluationSlicesCallable().call(request);
for (ModelEvaluationSlice element : response.getModelEvaluationSlicesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final ModelServiceClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : modelServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ModelServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
modelServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = modelServiceClient.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;
}
}
}
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = modelServiceClient.getLocation(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = modelServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = modelServiceClient.setIamPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = modelServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = modelServiceClient.getIamPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = modelServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = modelServiceClient.testIamPermissions(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
modelServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.