Package com.google.cloud.aiplatform.v1

Class JobServiceClient

java.lang.Object
com.google.cloud.aiplatform.v1.JobServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class JobServiceClient extends Object implements BackgroundResource
Service Description: A service for creating and managing Vertex AI's jobs.

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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CustomJob customJob = CustomJob.newBuilder().build();
   CustomJob response = jobServiceClient.createCustomJob(parent, customJob);
 }

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

Methods
Method Description Method Variants

CreateCustomJob

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

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

  • createCustomJob(CreateCustomJobRequest request)

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

  • createCustomJob(LocationName parent, CustomJob customJob)

  • createCustomJob(String parent, CustomJob customJob)

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

  • createCustomJobCallable()

GetCustomJob

Gets a CustomJob.

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

  • getCustomJob(GetCustomJobRequest request)

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

  • getCustomJob(CustomJobName name)

  • getCustomJob(String name)

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

  • getCustomJobCallable()

ListCustomJobs

Lists CustomJobs in a Location.

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

  • listCustomJobs(ListCustomJobsRequest request)

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

  • listCustomJobs(LocationName parent)

  • listCustomJobs(String parent)

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

  • listCustomJobsPagedCallable()

  • listCustomJobsCallable()

DeleteCustomJob

Deletes a CustomJob.

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

  • deleteCustomJobAsync(DeleteCustomJobRequest request)

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

  • deleteCustomJobAsync(CustomJobName name)

  • deleteCustomJobAsync(String name)

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

  • deleteCustomJobOperationCallable()

  • deleteCustomJobCallable()

CancelCustomJob

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.

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

  • cancelCustomJob(CancelCustomJobRequest request)

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

  • cancelCustomJob(CustomJobName name)

  • cancelCustomJob(String name)

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

  • cancelCustomJobCallable()

CreateDataLabelingJob

Creates a DataLabelingJob.

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

  • createDataLabelingJob(CreateDataLabelingJobRequest request)

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

  • createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob)

  • createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob)

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

  • createDataLabelingJobCallable()

GetDataLabelingJob

Gets a DataLabelingJob.

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

  • getDataLabelingJob(GetDataLabelingJobRequest request)

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

  • getDataLabelingJob(DataLabelingJobName name)

  • getDataLabelingJob(String name)

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

  • getDataLabelingJobCallable()

ListDataLabelingJobs

Lists DataLabelingJobs in a Location.

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

  • listDataLabelingJobs(ListDataLabelingJobsRequest request)

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

  • listDataLabelingJobs(LocationName parent)

  • listDataLabelingJobs(String parent)

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

  • listDataLabelingJobsPagedCallable()

  • listDataLabelingJobsCallable()

DeleteDataLabelingJob

Deletes a DataLabelingJob.

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

  • deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request)

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

  • deleteDataLabelingJobAsync(DataLabelingJobName name)

  • deleteDataLabelingJobAsync(String name)

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

  • deleteDataLabelingJobOperationCallable()

  • deleteDataLabelingJobCallable()

CancelDataLabelingJob

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

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

  • cancelDataLabelingJob(CancelDataLabelingJobRequest request)

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

  • cancelDataLabelingJob(DataLabelingJobName name)

  • cancelDataLabelingJob(String name)

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

  • cancelDataLabelingJobCallable()

CreateHyperparameterTuningJob

Creates a HyperparameterTuningJob

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

  • createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

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

  • createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob)

  • createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob)

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

  • createHyperparameterTuningJobCallable()

GetHyperparameterTuningJob

Gets a HyperparameterTuningJob

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

  • getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

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

  • getHyperparameterTuningJob(HyperparameterTuningJobName name)

  • getHyperparameterTuningJob(String name)

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

  • getHyperparameterTuningJobCallable()

ListHyperparameterTuningJobs

Lists HyperparameterTuningJobs in a Location.

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

  • listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

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

  • listHyperparameterTuningJobs(LocationName parent)

  • listHyperparameterTuningJobs(String parent)

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

  • listHyperparameterTuningJobsPagedCallable()

  • listHyperparameterTuningJobsCallable()

DeleteHyperparameterTuningJob

Deletes a HyperparameterTuningJob.

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

  • deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request)

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

  • deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name)

  • deleteHyperparameterTuningJobAsync(String name)

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

  • deleteHyperparameterTuningJobOperationCallable()

  • deleteHyperparameterTuningJobCallable()

CancelHyperparameterTuningJob

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.

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

  • cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request)

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

  • cancelHyperparameterTuningJob(HyperparameterTuningJobName name)

  • cancelHyperparameterTuningJob(String name)

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

  • cancelHyperparameterTuningJobCallable()

CreateNasJob

Creates a NasJob

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

  • createNasJob(CreateNasJobRequest request)

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

  • createNasJob(LocationName parent, NasJob nasJob)

  • createNasJob(String parent, NasJob nasJob)

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

  • createNasJobCallable()

GetNasJob

Gets a NasJob

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

  • getNasJob(GetNasJobRequest request)

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

  • getNasJob(NasJobName name)

  • getNasJob(String name)

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

  • getNasJobCallable()

ListNasJobs

Lists NasJobs in a Location.

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

  • listNasJobs(ListNasJobsRequest request)

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

  • listNasJobs(LocationName parent)

  • listNasJobs(String parent)

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

  • listNasJobsPagedCallable()

  • listNasJobsCallable()

DeleteNasJob

Deletes a NasJob.

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

  • deleteNasJobAsync(DeleteNasJobRequest request)

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

  • deleteNasJobAsync(NasJobName name)

  • deleteNasJobAsync(String name)

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

  • deleteNasJobOperationCallable()

  • deleteNasJobCallable()

CancelNasJob

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.

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

  • cancelNasJob(CancelNasJobRequest request)

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

  • cancelNasJob(NasJobName name)

  • cancelNasJob(String name)

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

  • cancelNasJobCallable()

GetNasTrialDetail

Gets a NasTrialDetail.

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

  • getNasTrialDetail(GetNasTrialDetailRequest request)

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

  • getNasTrialDetail(NasTrialDetailName name)

  • getNasTrialDetail(String name)

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

  • getNasTrialDetailCallable()

ListNasTrialDetails

List top NasTrialDetails of a NasJob.

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

  • listNasTrialDetails(ListNasTrialDetailsRequest request)

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

  • listNasTrialDetails(NasJobName parent)

  • listNasTrialDetails(String parent)

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

  • listNasTrialDetailsPagedCallable()

  • listNasTrialDetailsCallable()

CreateBatchPredictionJob

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

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

  • createBatchPredictionJob(CreateBatchPredictionJobRequest request)

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

  • createBatchPredictionJob(LocationName parent, BatchPredictionJob batchPredictionJob)

  • createBatchPredictionJob(String parent, BatchPredictionJob batchPredictionJob)

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

  • createBatchPredictionJobCallable()

GetBatchPredictionJob

Gets a BatchPredictionJob

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

  • getBatchPredictionJob(GetBatchPredictionJobRequest request)

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

  • getBatchPredictionJob(BatchPredictionJobName name)

  • getBatchPredictionJob(String name)

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

  • getBatchPredictionJobCallable()

ListBatchPredictionJobs

Lists BatchPredictionJobs in a Location.

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

  • listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

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

  • listBatchPredictionJobs(LocationName parent)

  • listBatchPredictionJobs(String parent)

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

  • listBatchPredictionJobsPagedCallable()

  • listBatchPredictionJobsCallable()

DeleteBatchPredictionJob

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

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

  • deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest request)

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

  • deleteBatchPredictionJobAsync(BatchPredictionJobName name)

  • deleteBatchPredictionJobAsync(String name)

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

  • deleteBatchPredictionJobOperationCallable()

  • deleteBatchPredictionJobCallable()

CancelBatchPredictionJob

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

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

  • cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)

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

  • cancelBatchPredictionJob(BatchPredictionJobName name)

  • cancelBatchPredictionJob(String name)

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

  • cancelBatchPredictionJobCallable()

CreateModelDeploymentMonitoringJob

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

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

  • createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

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

  • createModelDeploymentMonitoringJob(LocationName parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob)

  • createModelDeploymentMonitoringJob(String parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob)

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

  • createModelDeploymentMonitoringJobCallable()

SearchModelDeploymentMonitoringStatsAnomalies

Searches Model Monitoring Statistics generated within a given time window.

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

  • searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

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

  • searchModelDeploymentMonitoringStatsAnomalies(ModelDeploymentMonitoringJobName modelDeploymentMonitoringJob, String deployedModelId)

  • searchModelDeploymentMonitoringStatsAnomalies(String modelDeploymentMonitoringJob, String deployedModelId)

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

  • searchModelDeploymentMonitoringStatsAnomaliesPagedCallable()

  • searchModelDeploymentMonitoringStatsAnomaliesCallable()

GetModelDeploymentMonitoringJob

Gets a ModelDeploymentMonitoringJob.

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

  • getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

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

  • getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)

  • getModelDeploymentMonitoringJob(String name)

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

  • getModelDeploymentMonitoringJobCallable()

ListModelDeploymentMonitoringJobs

Lists ModelDeploymentMonitoringJobs in a Location.

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

  • listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

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

  • listModelDeploymentMonitoringJobs(LocationName parent)

  • listModelDeploymentMonitoringJobs(String parent)

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

  • listModelDeploymentMonitoringJobsPagedCallable()

  • listModelDeploymentMonitoringJobsCallable()

UpdateModelDeploymentMonitoringJob

Updates a ModelDeploymentMonitoringJob.

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

  • updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request)

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

  • updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, FieldMask updateMask)

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

  • updateModelDeploymentMonitoringJobOperationCallable()

  • updateModelDeploymentMonitoringJobCallable()

DeleteModelDeploymentMonitoringJob

Deletes a ModelDeploymentMonitoringJob.

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

  • deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request)

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

  • deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name)

  • deleteModelDeploymentMonitoringJobAsync(String name)

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

  • deleteModelDeploymentMonitoringJobOperationCallable()

  • deleteModelDeploymentMonitoringJobCallable()

PauseModelDeploymentMonitoringJob

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

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

  • pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request)

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

  • pauseModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)

  • pauseModelDeploymentMonitoringJob(String name)

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

  • pauseModelDeploymentMonitoringJobCallable()

ResumeModelDeploymentMonitoringJob

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

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

  • resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)

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

  • resumeModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)

  • resumeModelDeploymentMonitoringJob(String name)

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

  • resumeModelDeploymentMonitoringJobCallable()

ListLocations

Lists information about the supported locations for this service.

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

  • listLocations(ListLocationsRequest request)

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

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

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

  • getLocation(GetLocationRequest request)

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

  • getLocationCallable()

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.

  • setIamPolicy(SetIamPolicyRequest request)

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

  • setIamPolicyCallable()

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.

  • getIamPolicy(GetIamPolicyRequest request)

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

  • getIamPolicyCallable()

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.

  • testIamPermissions(TestIamPermissionsRequest request)

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

  • testIamPermissionsCallable()

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 JobServiceSettings 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
 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);

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
 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);

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

  • Constructor Details

    • JobServiceClient

      protected JobServiceClient(JobServiceSettings settings) throws IOException
      Constructs an instance of JobServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
      Throws:
      IOException

    • JobServiceClient

      protected JobServiceClient(JobServiceStub stub)

  • Method Details

    • create

      public static final JobServiceClient create() throws IOException
      Constructs an instance of JobServiceClient with default settings.
      Throws:
      IOException

    • create

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

    • create

      public static final JobServiceClient create(JobServiceStub stub)
      Constructs an instance of JobServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(JobServiceSettings).

    • getSettings

      public final JobServiceSettings getSettings()

    • getStub

      public JobServiceStub getStub()

    • getOperationsClient

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

    • createCustomJob

      public final CustomJob createCustomJob(LocationName parent, CustomJob customJob)
      Creates a CustomJob. A created CustomJob right away will be attempted to be run.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CustomJob customJob = CustomJob.newBuilder().build();
   CustomJob response = jobServiceClient.createCustomJob(parent, customJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`
      customJob - Required. The CustomJob to create.
      Throws:
      ApiException - if the remote call fails

    • createCustomJob

      public final CustomJob createCustomJob(String parent, CustomJob customJob)
      Creates a CustomJob. A created CustomJob right away will be attempted to be run.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CustomJob customJob = CustomJob.newBuilder().build();
   CustomJob response = jobServiceClient.createCustomJob(parent, customJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`
      customJob - Required. The CustomJob to create.
      Throws:
      ApiException - if the remote call fails

    • createCustomJob

      public final CustomJob createCustomJob(CreateCustomJobRequest request)
      Creates a CustomJob. A created CustomJob right away will be attempted to be run.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateCustomJobRequest request =
       CreateCustomJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCustomJob(CustomJob.newBuilder().build())
           .build();
   CustomJob response = jobServiceClient.createCustomJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createCustomJobCallable

      public final UnaryCallable<CreateCustomJobRequest,CustomJob> createCustomJobCallable()
      Creates a CustomJob. A created CustomJob right away will be attempted to be run.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateCustomJobRequest request =
       CreateCustomJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCustomJob(CustomJob.newBuilder().build())
           .build();
   ApiFuture<CustomJob> future = jobServiceClient.createCustomJobCallable().futureCall(request);
   // Do something.
   CustomJob response = future.get();
 }

    • getCustomJob

      public final CustomJob getCustomJob(CustomJobName name)
      Gets a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CustomJobName name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
   CustomJob response = jobServiceClient.getCustomJob(name);
 }
      Parameters:
      name - Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
      Throws:
      ApiException - if the remote call fails

    • getCustomJob

      public final CustomJob getCustomJob(String name)
      Gets a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString();
   CustomJob response = jobServiceClient.getCustomJob(name);
 }
      Parameters:
      name - Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
      Throws:
      ApiException - if the remote call fails

    • getCustomJob

      public final CustomJob getCustomJob(GetCustomJobRequest request)
      Gets a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetCustomJobRequest request =
       GetCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   CustomJob response = jobServiceClient.getCustomJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getCustomJobCallable

      public final UnaryCallable<GetCustomJobRequest,CustomJob> getCustomJobCallable()
      Gets a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetCustomJobRequest request =
       GetCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   ApiFuture<CustomJob> future = jobServiceClient.getCustomJobCallable().futureCall(request);
   // Do something.
   CustomJob response = future.get();
 }

    • listCustomJobs

      public final JobServiceClient.ListCustomJobsPagedResponse listCustomJobs(LocationName parent)
      Lists CustomJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (CustomJob element : jobServiceClient.listCustomJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listCustomJobs

      public final JobServiceClient.ListCustomJobsPagedResponse listCustomJobs(String parent)
      Lists CustomJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (CustomJob element : jobServiceClient.listCustomJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listCustomJobs

      public final JobServiceClient.ListCustomJobsPagedResponse listCustomJobs(ListCustomJobsRequest request)
      Lists CustomJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListCustomJobsRequest request =
       ListCustomJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (CustomJob element : jobServiceClient.listCustomJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listCustomJobsPagedCallable

      public final UnaryCallable<ListCustomJobsRequest,JobServiceClient.ListCustomJobsPagedResponse> listCustomJobsPagedCallable()
      Lists CustomJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListCustomJobsRequest request =
       ListCustomJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CustomJob> future =
       jobServiceClient.listCustomJobsPagedCallable().futureCall(request);
   // Do something.
   for (CustomJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listCustomJobsCallable

      public final UnaryCallable<ListCustomJobsRequest,ListCustomJobsResponse> listCustomJobsCallable()
      Lists CustomJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListCustomJobsRequest request =
       ListCustomJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListCustomJobsResponse response = jobServiceClient.listCustomJobsCallable().call(request);
     for (CustomJob element : response.getCustomJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • deleteCustomJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteCustomJobAsync(CustomJobName name)
      Deletes a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CustomJobName name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
   jobServiceClient.deleteCustomJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteCustomJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteCustomJobAsync(String name)
      Deletes a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString();
   jobServiceClient.deleteCustomJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteCustomJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteCustomJobAsync(DeleteCustomJobRequest request)
      Deletes a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteCustomJobRequest request =
       DeleteCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   jobServiceClient.deleteCustomJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteCustomJobOperationCallable

      public final OperationCallable<DeleteCustomJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteCustomJobOperationCallable()
      Deletes a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteCustomJobRequest request =
       DeleteCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       jobServiceClient.deleteCustomJobOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteCustomJobCallable

      public final UnaryCallable<DeleteCustomJobRequest,Operation> deleteCustomJobCallable()
      Deletes a CustomJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteCustomJobRequest request =
       DeleteCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   ApiFuture<Operation> future = jobServiceClient.deleteCustomJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • cancelCustomJob

      public final void cancelCustomJob(CustomJobName name)
      Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CustomJobName name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
   jobServiceClient.cancelCustomJob(name);
 }
      Parameters:
      name - Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelCustomJob

      public final void cancelCustomJob(String name)
      Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString();
   jobServiceClient.cancelCustomJob(name);
 }
      Parameters:
      name - Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelCustomJob

      public final void cancelCustomJob(CancelCustomJobRequest request)
      Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelCustomJobRequest request =
       CancelCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   jobServiceClient.cancelCustomJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • cancelCustomJobCallable

      public final UnaryCallable<CancelCustomJobRequest,com.google.protobuf.Empty> cancelCustomJobCallable()
      Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelCustomJobRequest request =
       CancelCustomJobRequest.newBuilder()
           .setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
           .build();
   ApiFuture<Empty> future = jobServiceClient.cancelCustomJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • createDataLabelingJob

      public final DataLabelingJob createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob)
      Creates a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DataLabelingJob dataLabelingJob = DataLabelingJob.newBuilder().build();
   DataLabelingJob response = jobServiceClient.createDataLabelingJob(parent, dataLabelingJob);
 }
      Parameters:
      parent - Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
      dataLabelingJob - Required. The DataLabelingJob to create.
      Throws:
      ApiException - if the remote call fails

    • createDataLabelingJob

      public final DataLabelingJob createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob)
      Creates a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DataLabelingJob dataLabelingJob = DataLabelingJob.newBuilder().build();
   DataLabelingJob response = jobServiceClient.createDataLabelingJob(parent, dataLabelingJob);
 }
      Parameters:
      parent - Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
      dataLabelingJob - Required. The DataLabelingJob to create.
      Throws:
      ApiException - if the remote call fails

    • createDataLabelingJob

      public final DataLabelingJob createDataLabelingJob(CreateDataLabelingJobRequest request)
      Creates a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateDataLabelingJobRequest request =
       CreateDataLabelingJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataLabelingJob(DataLabelingJob.newBuilder().build())
           .build();
   DataLabelingJob response = jobServiceClient.createDataLabelingJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createDataLabelingJobCallable

      public final UnaryCallable<CreateDataLabelingJobRequest,DataLabelingJob> createDataLabelingJobCallable()
      Creates a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateDataLabelingJobRequest request =
       CreateDataLabelingJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataLabelingJob(DataLabelingJob.newBuilder().build())
           .build();
   ApiFuture<DataLabelingJob> future =
       jobServiceClient.createDataLabelingJobCallable().futureCall(request);
   // Do something.
   DataLabelingJob response = future.get();
 }

    • getDataLabelingJob

      public final DataLabelingJob getDataLabelingJob(DataLabelingJobName name)
      Gets a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DataLabelingJobName name =
       DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
   DataLabelingJob response = jobServiceClient.getDataLabelingJob(name);
 }
      Parameters:
      name - Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
      Throws:
      ApiException - if the remote call fails

    • getDataLabelingJob

      public final DataLabelingJob getDataLabelingJob(String name)
      Gets a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]").toString();
   DataLabelingJob response = jobServiceClient.getDataLabelingJob(name);
 }
      Parameters:
      name - Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
      Throws:
      ApiException - if the remote call fails

    • getDataLabelingJob

      public final DataLabelingJob getDataLabelingJob(GetDataLabelingJobRequest request)
      Gets a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetDataLabelingJobRequest request =
       GetDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   DataLabelingJob response = jobServiceClient.getDataLabelingJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getDataLabelingJobCallable

      public final UnaryCallable<GetDataLabelingJobRequest,DataLabelingJob> getDataLabelingJobCallable()
      Gets a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetDataLabelingJobRequest request =
       GetDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   ApiFuture<DataLabelingJob> future =
       jobServiceClient.getDataLabelingJobCallable().futureCall(request);
   // Do something.
   DataLabelingJob response = future.get();
 }

    • listDataLabelingJobs

      public final JobServiceClient.ListDataLabelingJobsPagedResponse listDataLabelingJobs(LocationName parent)
      Lists DataLabelingJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DataLabelingJob element : jobServiceClient.listDataLabelingJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listDataLabelingJobs

      public final JobServiceClient.ListDataLabelingJobsPagedResponse listDataLabelingJobs(String parent)
      Lists DataLabelingJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (DataLabelingJob element : jobServiceClient.listDataLabelingJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listDataLabelingJobs

      public final JobServiceClient.ListDataLabelingJobsPagedResponse listDataLabelingJobs(ListDataLabelingJobsRequest request)
      Lists DataLabelingJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListDataLabelingJobsRequest request =
       ListDataLabelingJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   for (DataLabelingJob element : jobServiceClient.listDataLabelingJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listDataLabelingJobsPagedCallable

      public final UnaryCallable<ListDataLabelingJobsRequest,JobServiceClient.ListDataLabelingJobsPagedResponse> listDataLabelingJobsPagedCallable()
      Lists DataLabelingJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListDataLabelingJobsRequest request =
       ListDataLabelingJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<DataLabelingJob> future =
       jobServiceClient.listDataLabelingJobsPagedCallable().futureCall(request);
   // Do something.
   for (DataLabelingJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listDataLabelingJobsCallable

      public final UnaryCallable<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse> listDataLabelingJobsCallable()
      Lists DataLabelingJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListDataLabelingJobsRequest request =
       ListDataLabelingJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDataLabelingJobsResponse response =
         jobServiceClient.listDataLabelingJobsCallable().call(request);
     for (DataLabelingJob element : response.getDataLabelingJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • deleteDataLabelingJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteDataLabelingJobAsync(DataLabelingJobName name)
      Deletes a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DataLabelingJobName name =
       DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
   jobServiceClient.deleteDataLabelingJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteDataLabelingJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteDataLabelingJobAsync(String name)
      Deletes a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]").toString();
   jobServiceClient.deleteDataLabelingJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteDataLabelingJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request)
      Deletes a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteDataLabelingJobRequest request =
       DeleteDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   jobServiceClient.deleteDataLabelingJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteDataLabelingJobOperationCallable

      public final OperationCallable<DeleteDataLabelingJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteDataLabelingJobOperationCallable()
      Deletes a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteDataLabelingJobRequest request =
       DeleteDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       jobServiceClient.deleteDataLabelingJobOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteDataLabelingJobCallable

      public final UnaryCallable<DeleteDataLabelingJobRequest,Operation> deleteDataLabelingJobCallable()
      Deletes a DataLabelingJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteDataLabelingJobRequest request =
       DeleteDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       jobServiceClient.deleteDataLabelingJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • cancelDataLabelingJob

      public final void cancelDataLabelingJob(DataLabelingJobName name)
      Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DataLabelingJobName name =
       DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
   jobServiceClient.cancelDataLabelingJob(name);
 }
      Parameters:
      name - Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelDataLabelingJob

      public final void cancelDataLabelingJob(String name)
      Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]").toString();
   jobServiceClient.cancelDataLabelingJob(name);
 }
      Parameters:
      name - Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelDataLabelingJob

      public final void cancelDataLabelingJob(CancelDataLabelingJobRequest request)
      Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelDataLabelingJobRequest request =
       CancelDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   jobServiceClient.cancelDataLabelingJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • cancelDataLabelingJobCallable

      public final UnaryCallable<CancelDataLabelingJobRequest,com.google.protobuf.Empty> cancelDataLabelingJobCallable()
      Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelDataLabelingJobRequest request =
       CancelDataLabelingJobRequest.newBuilder()
           .setName(
               DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       jobServiceClient.cancelDataLabelingJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • createHyperparameterTuningJob

      public final HyperparameterTuningJob createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob)
      Creates a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   HyperparameterTuningJob hyperparameterTuningJob =
       HyperparameterTuningJob.newBuilder().build();
   HyperparameterTuningJob response =
       jobServiceClient.createHyperparameterTuningJob(parent, hyperparameterTuningJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`
      hyperparameterTuningJob - Required. The HyperparameterTuningJob to create.
      Throws:
      ApiException - if the remote call fails

    • createHyperparameterTuningJob

      public final HyperparameterTuningJob createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob)
      Creates a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   HyperparameterTuningJob hyperparameterTuningJob =
       HyperparameterTuningJob.newBuilder().build();
   HyperparameterTuningJob response =
       jobServiceClient.createHyperparameterTuningJob(parent, hyperparameterTuningJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`
      hyperparameterTuningJob - Required. The HyperparameterTuningJob to create.
      Throws:
      ApiException - if the remote call fails

    • createHyperparameterTuningJob

      public final HyperparameterTuningJob createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)
      Creates a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateHyperparameterTuningJobRequest request =
       CreateHyperparameterTuningJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setHyperparameterTuningJob(HyperparameterTuningJob.newBuilder().build())
           .build();
   HyperparameterTuningJob response = jobServiceClient.createHyperparameterTuningJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createHyperparameterTuningJobCallable

      public final UnaryCallable<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob> createHyperparameterTuningJobCallable()
      Creates a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateHyperparameterTuningJobRequest request =
       CreateHyperparameterTuningJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setHyperparameterTuningJob(HyperparameterTuningJob.newBuilder().build())
           .build();
   ApiFuture<HyperparameterTuningJob> future =
       jobServiceClient.createHyperparameterTuningJobCallable().futureCall(request);
   // Do something.
   HyperparameterTuningJob response = future.get();
 }

    • getHyperparameterTuningJob

      public final HyperparameterTuningJob getHyperparameterTuningJob(HyperparameterTuningJobName name)
      Gets a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   HyperparameterTuningJobName name =
       HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
   HyperparameterTuningJob response = jobServiceClient.getHyperparameterTuningJob(name);
 }
      Parameters:
      name - Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
      Throws:
      ApiException - if the remote call fails

    • getHyperparameterTuningJob

      public final HyperparameterTuningJob getHyperparameterTuningJob(String name)
      Gets a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
           .toString();
   HyperparameterTuningJob response = jobServiceClient.getHyperparameterTuningJob(name);
 }
      Parameters:
      name - Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
      Throws:
      ApiException - if the remote call fails

    • getHyperparameterTuningJob

      public final HyperparameterTuningJob getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)
      Gets a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetHyperparameterTuningJobRequest request =
       GetHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   HyperparameterTuningJob response = jobServiceClient.getHyperparameterTuningJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getHyperparameterTuningJobCallable

      public final UnaryCallable<GetHyperparameterTuningJobRequest,HyperparameterTuningJob> getHyperparameterTuningJobCallable()
      Gets a HyperparameterTuningJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetHyperparameterTuningJobRequest request =
       GetHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   ApiFuture<HyperparameterTuningJob> future =
       jobServiceClient.getHyperparameterTuningJobCallable().futureCall(request);
   // Do something.
   HyperparameterTuningJob response = future.get();
 }

    • listHyperparameterTuningJobs

      public final JobServiceClient.ListHyperparameterTuningJobsPagedResponse listHyperparameterTuningJobs(LocationName parent)
      Lists HyperparameterTuningJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (HyperparameterTuningJob element :
       jobServiceClient.listHyperparameterTuningJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listHyperparameterTuningJobs

      public final JobServiceClient.ListHyperparameterTuningJobsPagedResponse listHyperparameterTuningJobs(String parent)
      Lists HyperparameterTuningJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (HyperparameterTuningJob element :
       jobServiceClient.listHyperparameterTuningJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listHyperparameterTuningJobs

      public final JobServiceClient.ListHyperparameterTuningJobsPagedResponse listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)
      Lists HyperparameterTuningJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListHyperparameterTuningJobsRequest request =
       ListHyperparameterTuningJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (HyperparameterTuningJob element :
       jobServiceClient.listHyperparameterTuningJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listHyperparameterTuningJobsPagedCallable

      public final UnaryCallable<ListHyperparameterTuningJobsRequest,JobServiceClient.ListHyperparameterTuningJobsPagedResponse> listHyperparameterTuningJobsPagedCallable()
      Lists HyperparameterTuningJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListHyperparameterTuningJobsRequest request =
       ListHyperparameterTuningJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<HyperparameterTuningJob> future =
       jobServiceClient.listHyperparameterTuningJobsPagedCallable().futureCall(request);
   // Do something.
   for (HyperparameterTuningJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listHyperparameterTuningJobsCallable

      public final UnaryCallable<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse> listHyperparameterTuningJobsCallable()
      Lists HyperparameterTuningJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListHyperparameterTuningJobsRequest request =
       ListHyperparameterTuningJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListHyperparameterTuningJobsResponse response =
         jobServiceClient.listHyperparameterTuningJobsCallable().call(request);
     for (HyperparameterTuningJob element : response.getHyperparameterTuningJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • deleteHyperparameterTuningJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name)
      Deletes a HyperparameterTuningJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   HyperparameterTuningJobName name =
       HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
   jobServiceClient.deleteHyperparameterTuningJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteHyperparameterTuningJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobAsync(String name)
      Deletes a HyperparameterTuningJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
           .toString();
   jobServiceClient.deleteHyperparameterTuningJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteHyperparameterTuningJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request)
      Deletes a HyperparameterTuningJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteHyperparameterTuningJobRequest request =
       DeleteHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   jobServiceClient.deleteHyperparameterTuningJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteHyperparameterTuningJobOperationCallable

      public final OperationCallable<DeleteHyperparameterTuningJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobOperationCallable()
      Deletes a HyperparameterTuningJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteHyperparameterTuningJobRequest request =
       DeleteHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       jobServiceClient.deleteHyperparameterTuningJobOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteHyperparameterTuningJobCallable

      public final UnaryCallable<DeleteHyperparameterTuningJobRequest,Operation> deleteHyperparameterTuningJobCallable()
      Deletes a HyperparameterTuningJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteHyperparameterTuningJobRequest request =
       DeleteHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       jobServiceClient.deleteHyperparameterTuningJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • cancelHyperparameterTuningJob

      public final void cancelHyperparameterTuningJob(HyperparameterTuningJobName name)
      Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   HyperparameterTuningJobName name =
       HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
   jobServiceClient.cancelHyperparameterTuningJob(name);
 }
      Parameters:
      name - Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelHyperparameterTuningJob

      public final void cancelHyperparameterTuningJob(String name)
      Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
           .toString();
   jobServiceClient.cancelHyperparameterTuningJob(name);
 }
      Parameters:
      name - Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelHyperparameterTuningJob

      public final void cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request)
      Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelHyperparameterTuningJobRequest request =
       CancelHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   jobServiceClient.cancelHyperparameterTuningJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • cancelHyperparameterTuningJobCallable

      public final UnaryCallable<CancelHyperparameterTuningJobRequest,com.google.protobuf.Empty> cancelHyperparameterTuningJobCallable()
      Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelHyperparameterTuningJobRequest request =
       CancelHyperparameterTuningJobRequest.newBuilder()
           .setName(
               HyperparameterTuningJobName.of(
                       "[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       jobServiceClient.cancelHyperparameterTuningJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • createNasJob

      public final NasJob createNasJob(LocationName parent, NasJob nasJob)
      Creates a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   NasJob nasJob = NasJob.newBuilder().build();
   NasJob response = jobServiceClient.createNasJob(parent, nasJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`
      nasJob - Required. The NasJob to create.
      Throws:
      ApiException - if the remote call fails

    • createNasJob

      public final NasJob createNasJob(String parent, NasJob nasJob)
      Creates a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   NasJob nasJob = NasJob.newBuilder().build();
   NasJob response = jobServiceClient.createNasJob(parent, nasJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`
      nasJob - Required. The NasJob to create.
      Throws:
      ApiException - if the remote call fails

    • createNasJob

      public final NasJob createNasJob(CreateNasJobRequest request)
      Creates a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateNasJobRequest request =
       CreateNasJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNasJob(NasJob.newBuilder().build())
           .build();
   NasJob response = jobServiceClient.createNasJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createNasJobCallable

      public final UnaryCallable<CreateNasJobRequest,NasJob> createNasJobCallable()
      Creates a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateNasJobRequest request =
       CreateNasJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setNasJob(NasJob.newBuilder().build())
           .build();
   ApiFuture<NasJob> future = jobServiceClient.createNasJobCallable().futureCall(request);
   // Do something.
   NasJob response = future.get();
 }

    • getNasJob

      public final NasJob getNasJob(NasJobName name)
      Gets a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   NasJobName name = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]");
   NasJob response = jobServiceClient.getNasJob(name);
 }
      Parameters:
      name - Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • getNasJob

      public final NasJob getNasJob(String name)
      Gets a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString();
   NasJob response = jobServiceClient.getNasJob(name);
 }
      Parameters:
      name - Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • getNasJob

      public final NasJob getNasJob(GetNasJobRequest request)
      Gets a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetNasJobRequest request =
       GetNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   NasJob response = jobServiceClient.getNasJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getNasJobCallable

      public final UnaryCallable<GetNasJobRequest,NasJob> getNasJobCallable()
      Gets a NasJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetNasJobRequest request =
       GetNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   ApiFuture<NasJob> future = jobServiceClient.getNasJobCallable().futureCall(request);
   // Do something.
   NasJob response = future.get();
 }

    • listNasJobs

      public final JobServiceClient.ListNasJobsPagedResponse listNasJobs(LocationName parent)
      Lists NasJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (NasJob element : jobServiceClient.listNasJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listNasJobs

      public final JobServiceClient.ListNasJobsPagedResponse listNasJobs(String parent)
      Lists NasJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (NasJob element : jobServiceClient.listNasJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listNasJobs

      public final JobServiceClient.ListNasJobsPagedResponse listNasJobs(ListNasJobsRequest request)
      Lists NasJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListNasJobsRequest request =
       ListNasJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (NasJob element : jobServiceClient.listNasJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listNasJobsPagedCallable

      public final UnaryCallable<ListNasJobsRequest,JobServiceClient.ListNasJobsPagedResponse> listNasJobsPagedCallable()
      Lists NasJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListNasJobsRequest request =
       ListNasJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<NasJob> future = jobServiceClient.listNasJobsPagedCallable().futureCall(request);
   // Do something.
   for (NasJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listNasJobsCallable

      public final UnaryCallable<ListNasJobsRequest,ListNasJobsResponse> listNasJobsCallable()
      Lists NasJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListNasJobsRequest request =
       ListNasJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListNasJobsResponse response = jobServiceClient.listNasJobsCallable().call(request);
     for (NasJob element : response.getNasJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • deleteNasJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteNasJobAsync(NasJobName name)
      Deletes a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   NasJobName name = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]");
   jobServiceClient.deleteNasJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteNasJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteNasJobAsync(String name)
      Deletes a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString();
   jobServiceClient.deleteNasJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteNasJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteNasJobAsync(DeleteNasJobRequest request)
      Deletes a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteNasJobRequest request =
       DeleteNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   jobServiceClient.deleteNasJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteNasJobOperationCallable

      public final OperationCallable<DeleteNasJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNasJobOperationCallable()
      Deletes a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteNasJobRequest request =
       DeleteNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       jobServiceClient.deleteNasJobOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteNasJobCallable

      public final UnaryCallable<DeleteNasJobRequest,Operation> deleteNasJobCallable()
      Deletes a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteNasJobRequest request =
       DeleteNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   ApiFuture<Operation> future = jobServiceClient.deleteNasJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • cancelNasJob

      public final void cancelNasJob(NasJobName name)
      Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   NasJobName name = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]");
   jobServiceClient.cancelNasJob(name);
 }
      Parameters:
      name - Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelNasJob

      public final void cancelNasJob(String name)
      Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString();
   jobServiceClient.cancelNasJob(name);
 }
      Parameters:
      name - Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelNasJob

      public final void cancelNasJob(CancelNasJobRequest request)
      Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelNasJobRequest request =
       CancelNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   jobServiceClient.cancelNasJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • cancelNasJobCallable

      public final UnaryCallable<CancelNasJobRequest,com.google.protobuf.Empty> cancelNasJobCallable()
      Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelNasJobRequest request =
       CancelNasJobRequest.newBuilder()
           .setName(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .build();
   ApiFuture<Empty> future = jobServiceClient.cancelNasJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • getNasTrialDetail

      public final NasTrialDetail getNasTrialDetail(NasTrialDetailName name)
      Gets a NasTrialDetail.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   NasTrialDetailName name =
       NasTrialDetailName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]", "[NAS_TRIAL_DETAIL]");
   NasTrialDetail response = jobServiceClient.getNasTrialDetail(name);
 }
      Parameters:
      name - Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
      Throws:
      ApiException - if the remote call fails

    • getNasTrialDetail

      public final NasTrialDetail getNasTrialDetail(String name)
      Gets a NasTrialDetail.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       NasTrialDetailName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]", "[NAS_TRIAL_DETAIL]")
           .toString();
   NasTrialDetail response = jobServiceClient.getNasTrialDetail(name);
 }
      Parameters:
      name - Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
      Throws:
      ApiException - if the remote call fails

    • getNasTrialDetail

      public final NasTrialDetail getNasTrialDetail(GetNasTrialDetailRequest request)
      Gets a NasTrialDetail.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetNasTrialDetailRequest request =
       GetNasTrialDetailRequest.newBuilder()
           .setName(
               NasTrialDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[NAS_JOB]", "[NAS_TRIAL_DETAIL]")
                   .toString())
           .build();
   NasTrialDetail response = jobServiceClient.getNasTrialDetail(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getNasTrialDetailCallable

      public final UnaryCallable<GetNasTrialDetailRequest,NasTrialDetail> getNasTrialDetailCallable()
      Gets a NasTrialDetail.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetNasTrialDetailRequest request =
       GetNasTrialDetailRequest.newBuilder()
           .setName(
               NasTrialDetailName.of(
                       "[PROJECT]", "[LOCATION]", "[NAS_JOB]", "[NAS_TRIAL_DETAIL]")
                   .toString())
           .build();
   ApiFuture<NasTrialDetail> future =
       jobServiceClient.getNasTrialDetailCallable().futureCall(request);
   // Do something.
   NasTrialDetail response = future.get();
 }

    • listNasTrialDetails

      public final JobServiceClient.ListNasTrialDetailsPagedResponse listNasTrialDetails(NasJobName parent)
      List top NasTrialDetails of a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   NasJobName parent = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]");
   for (NasTrialDetail element : jobServiceClient.listNasTrialDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • listNasTrialDetails

      public final JobServiceClient.ListNasTrialDetailsPagedResponse listNasTrialDetails(String parent)
      List top NasTrialDetails of a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString();
   for (NasTrialDetail element : jobServiceClient.listNasTrialDetails(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`
      Throws:
      ApiException - if the remote call fails

    • listNasTrialDetails

      public final JobServiceClient.ListNasTrialDetailsPagedResponse listNasTrialDetails(ListNasTrialDetailsRequest request)
      List top NasTrialDetails of a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListNasTrialDetailsRequest request =
       ListNasTrialDetailsRequest.newBuilder()
           .setParent(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (NasTrialDetail element : jobServiceClient.listNasTrialDetails(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listNasTrialDetailsPagedCallable

      public final UnaryCallable<ListNasTrialDetailsRequest,JobServiceClient.ListNasTrialDetailsPagedResponse> listNasTrialDetailsPagedCallable()
      List top NasTrialDetails of a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListNasTrialDetailsRequest request =
       ListNasTrialDetailsRequest.newBuilder()
           .setParent(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<NasTrialDetail> future =
       jobServiceClient.listNasTrialDetailsPagedCallable().futureCall(request);
   // Do something.
   for (NasTrialDetail element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listNasTrialDetailsCallable

      public final UnaryCallable<ListNasTrialDetailsRequest,ListNasTrialDetailsResponse> listNasTrialDetailsCallable()
      List top NasTrialDetails of a NasJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListNasTrialDetailsRequest request =
       ListNasTrialDetailsRequest.newBuilder()
           .setParent(NasJobName.of("[PROJECT]", "[LOCATION]", "[NAS_JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListNasTrialDetailsResponse response =
         jobServiceClient.listNasTrialDetailsCallable().call(request);
     for (NasTrialDetail element : response.getNasTrialDetailsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • createBatchPredictionJob

      public final BatchPredictionJob createBatchPredictionJob(LocationName parent, BatchPredictionJob batchPredictionJob)
      Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   BatchPredictionJob batchPredictionJob = BatchPredictionJob.newBuilder().build();
   BatchPredictionJob response =
       jobServiceClient.createBatchPredictionJob(parent, batchPredictionJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
      batchPredictionJob - Required. The BatchPredictionJob to create.
      Throws:
      ApiException - if the remote call fails

    • createBatchPredictionJob

      public final BatchPredictionJob createBatchPredictionJob(String parent, BatchPredictionJob batchPredictionJob)
      Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   BatchPredictionJob batchPredictionJob = BatchPredictionJob.newBuilder().build();
   BatchPredictionJob response =
       jobServiceClient.createBatchPredictionJob(parent, batchPredictionJob);
 }
      Parameters:
      parent - Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
      batchPredictionJob - Required. The BatchPredictionJob to create.
      Throws:
      ApiException - if the remote call fails

    • createBatchPredictionJob

      public final BatchPredictionJob createBatchPredictionJob(CreateBatchPredictionJobRequest request)
      Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateBatchPredictionJobRequest request =
       CreateBatchPredictionJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBatchPredictionJob(BatchPredictionJob.newBuilder().build())
           .build();
   BatchPredictionJob response = jobServiceClient.createBatchPredictionJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createBatchPredictionJobCallable

      public final UnaryCallable<CreateBatchPredictionJobRequest,BatchPredictionJob> createBatchPredictionJobCallable()
      Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateBatchPredictionJobRequest request =
       CreateBatchPredictionJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBatchPredictionJob(BatchPredictionJob.newBuilder().build())
           .build();
   ApiFuture<BatchPredictionJob> future =
       jobServiceClient.createBatchPredictionJobCallable().futureCall(request);
   // Do something.
   BatchPredictionJob response = future.get();
 }

    • getBatchPredictionJob

      public final BatchPredictionJob getBatchPredictionJob(BatchPredictionJobName name)
      Gets a BatchPredictionJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   BatchPredictionJobName name =
       BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
   BatchPredictionJob response = jobServiceClient.getBatchPredictionJob(name);
 }
      Parameters:
      name - Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
      Throws:
      ApiException - if the remote call fails

    • getBatchPredictionJob

      public final BatchPredictionJob getBatchPredictionJob(String name)
      Gets a BatchPredictionJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]").toString();
   BatchPredictionJob response = jobServiceClient.getBatchPredictionJob(name);
 }
      Parameters:
      name - Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
      Throws:
      ApiException - if the remote call fails

    • getBatchPredictionJob

      public final BatchPredictionJob getBatchPredictionJob(GetBatchPredictionJobRequest request)
      Gets a BatchPredictionJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetBatchPredictionJobRequest request =
       GetBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   BatchPredictionJob response = jobServiceClient.getBatchPredictionJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getBatchPredictionJobCallable

      public final UnaryCallable<GetBatchPredictionJobRequest,BatchPredictionJob> getBatchPredictionJobCallable()
      Gets a BatchPredictionJob

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetBatchPredictionJobRequest request =
       GetBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   ApiFuture<BatchPredictionJob> future =
       jobServiceClient.getBatchPredictionJobCallable().futureCall(request);
   // Do something.
   BatchPredictionJob response = future.get();
 }

    • listBatchPredictionJobs

      public final JobServiceClient.ListBatchPredictionJobsPagedResponse listBatchPredictionJobs(LocationName parent)
      Lists BatchPredictionJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (BatchPredictionJob element :
       jobServiceClient.listBatchPredictionJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listBatchPredictionJobs

      public final JobServiceClient.ListBatchPredictionJobsPagedResponse listBatchPredictionJobs(String parent)
      Lists BatchPredictionJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (BatchPredictionJob element :
       jobServiceClient.listBatchPredictionJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listBatchPredictionJobs

      public final JobServiceClient.ListBatchPredictionJobsPagedResponse listBatchPredictionJobs(ListBatchPredictionJobsRequest request)
      Lists BatchPredictionJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListBatchPredictionJobsRequest request =
       ListBatchPredictionJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (BatchPredictionJob element :
       jobServiceClient.listBatchPredictionJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listBatchPredictionJobsPagedCallable

      public final UnaryCallable<ListBatchPredictionJobsRequest,JobServiceClient.ListBatchPredictionJobsPagedResponse> listBatchPredictionJobsPagedCallable()
      Lists BatchPredictionJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListBatchPredictionJobsRequest request =
       ListBatchPredictionJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<BatchPredictionJob> future =
       jobServiceClient.listBatchPredictionJobsPagedCallable().futureCall(request);
   // Do something.
   for (BatchPredictionJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listBatchPredictionJobsCallable

      public final UnaryCallable<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse> listBatchPredictionJobsCallable()
      Lists BatchPredictionJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListBatchPredictionJobsRequest request =
       ListBatchPredictionJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListBatchPredictionJobsResponse response =
         jobServiceClient.listBatchPredictionJobsCallable().call(request);
     for (BatchPredictionJob element : response.getBatchPredictionJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • deleteBatchPredictionJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteBatchPredictionJobAsync(BatchPredictionJobName name)
      Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   BatchPredictionJobName name =
       BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
   jobServiceClient.deleteBatchPredictionJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteBatchPredictionJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteBatchPredictionJobAsync(String name)
      Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]").toString();
   jobServiceClient.deleteBatchPredictionJobAsync(name).get();
 }
      Parameters:
      name - Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteBatchPredictionJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest request)
      Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteBatchPredictionJobRequest request =
       DeleteBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   jobServiceClient.deleteBatchPredictionJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteBatchPredictionJobOperationCallable

      public final OperationCallable<DeleteBatchPredictionJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteBatchPredictionJobOperationCallable()
      Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteBatchPredictionJobRequest request =
       DeleteBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       jobServiceClient.deleteBatchPredictionJobOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteBatchPredictionJobCallable

      public final UnaryCallable<DeleteBatchPredictionJobRequest,Operation> deleteBatchPredictionJobCallable()
      Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteBatchPredictionJobRequest request =
       DeleteBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       jobServiceClient.deleteBatchPredictionJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • cancelBatchPredictionJob

      public final void cancelBatchPredictionJob(BatchPredictionJobName name)
      Cancels a BatchPredictionJob.

      Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   BatchPredictionJobName name =
       BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
   jobServiceClient.cancelBatchPredictionJob(name);
 }
      Parameters:
      name - Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelBatchPredictionJob

      public final void cancelBatchPredictionJob(String name)
      Cancels a BatchPredictionJob.

      Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]").toString();
   jobServiceClient.cancelBatchPredictionJob(name);
 }
      Parameters:
      name - Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
      Throws:
      ApiException - if the remote call fails

    • cancelBatchPredictionJob

      public final void cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)
      Cancels a BatchPredictionJob.

      Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelBatchPredictionJobRequest request =
       CancelBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   jobServiceClient.cancelBatchPredictionJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • cancelBatchPredictionJobCallable

      public final UnaryCallable<CancelBatchPredictionJobRequest,com.google.protobuf.Empty> cancelBatchPredictionJobCallable()
      Cancels a BatchPredictionJob.

      Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CancelBatchPredictionJobRequest request =
       CancelBatchPredictionJobRequest.newBuilder()
           .setName(
               BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       jobServiceClient.cancelBatchPredictionJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • createModelDeploymentMonitoringJob

      public final ModelDeploymentMonitoringJob createModelDeploymentMonitoringJob(LocationName parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob)
      Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ModelDeploymentMonitoringJob modelDeploymentMonitoringJob =
       ModelDeploymentMonitoringJob.newBuilder().build();
   ModelDeploymentMonitoringJob response =
       jobServiceClient.createModelDeploymentMonitoringJob(parent, modelDeploymentMonitoringJob);
 }
      Parameters:
      parent - Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
      modelDeploymentMonitoringJob - Required. The ModelDeploymentMonitoringJob to create
      Throws:
      ApiException - if the remote call fails

    • createModelDeploymentMonitoringJob

      public final ModelDeploymentMonitoringJob createModelDeploymentMonitoringJob(String parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob)
      Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ModelDeploymentMonitoringJob modelDeploymentMonitoringJob =
       ModelDeploymentMonitoringJob.newBuilder().build();
   ModelDeploymentMonitoringJob response =
       jobServiceClient.createModelDeploymentMonitoringJob(parent, modelDeploymentMonitoringJob);
 }
      Parameters:
      parent - Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
      modelDeploymentMonitoringJob - Required. The ModelDeploymentMonitoringJob to create
      Throws:
      ApiException - if the remote call fails

    • createModelDeploymentMonitoringJob

      public final ModelDeploymentMonitoringJob createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)
      Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateModelDeploymentMonitoringJobRequest request =
       CreateModelDeploymentMonitoringJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModelDeploymentMonitoringJob(ModelDeploymentMonitoringJob.newBuilder().build())
           .build();
   ModelDeploymentMonitoringJob response =
       jobServiceClient.createModelDeploymentMonitoringJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createModelDeploymentMonitoringJobCallable

      public final UnaryCallable<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJobCallable()
      Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   CreateModelDeploymentMonitoringJobRequest request =
       CreateModelDeploymentMonitoringJobRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModelDeploymentMonitoringJob(ModelDeploymentMonitoringJob.newBuilder().build())
           .build();
   ApiFuture<ModelDeploymentMonitoringJob> future =
       jobServiceClient.createModelDeploymentMonitoringJobCallable().futureCall(request);
   // Do something.
   ModelDeploymentMonitoringJob response = future.get();
 }

    • searchModelDeploymentMonitoringStatsAnomalies

      public final JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse searchModelDeploymentMonitoringStatsAnomalies(ModelDeploymentMonitoringJobName modelDeploymentMonitoringJob, String deployedModelId)
      Searches Model Monitoring Statistics generated within a given time window.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ModelDeploymentMonitoringJobName modelDeploymentMonitoringJob =
       ModelDeploymentMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
   String deployedModelId = "deployedModelId-1817547906";
   for (ModelMonitoringStatsAnomalies element :
       jobServiceClient
           .searchModelDeploymentMonitoringStatsAnomalies(
               modelDeploymentMonitoringJob, deployedModelId)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      modelDeploymentMonitoringJob - Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      deployedModelId - Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].
      Throws:
      ApiException - if the remote call fails

    • searchModelDeploymentMonitoringStatsAnomalies

      public final JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse searchModelDeploymentMonitoringStatsAnomalies(String modelDeploymentMonitoringJob, String deployedModelId)
      Searches Model Monitoring Statistics generated within a given time window.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String modelDeploymentMonitoringJob =
       ModelDeploymentMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
           .toString();
   String deployedModelId = "deployedModelId-1817547906";
   for (ModelMonitoringStatsAnomalies element :
       jobServiceClient
           .searchModelDeploymentMonitoringStatsAnomalies(
               modelDeploymentMonitoringJob, deployedModelId)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      modelDeploymentMonitoringJob - Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      deployedModelId - Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].
      Throws:
      ApiException - if the remote call fails

    • searchModelDeploymentMonitoringStatsAnomalies

      public final JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)
      Searches Model Monitoring Statistics generated within a given time window.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   SearchModelDeploymentMonitoringStatsAnomaliesRequest request =
       SearchModelDeploymentMonitoringStatsAnomaliesRequest.newBuilder()
           .setModelDeploymentMonitoringJob(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .setDeployedModelId("deployedModelId-1817547906")
           .setFeatureDisplayName("featureDisplayName-1741181545")
           .addAllObjectives(
               new ArrayList<
                   SearchModelDeploymentMonitoringStatsAnomaliesRequest
                       .StatsAnomaliesObjective>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .build();
   for (ModelMonitoringStatsAnomalies element :
       jobServiceClient.searchModelDeploymentMonitoringStatsAnomalies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • searchModelDeploymentMonitoringStatsAnomaliesPagedCallable

      public final UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse> searchModelDeploymentMonitoringStatsAnomaliesPagedCallable()
      Searches Model Monitoring Statistics generated within a given time window.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   SearchModelDeploymentMonitoringStatsAnomaliesRequest request =
       SearchModelDeploymentMonitoringStatsAnomaliesRequest.newBuilder()
           .setModelDeploymentMonitoringJob(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .setDeployedModelId("deployedModelId-1817547906")
           .setFeatureDisplayName("featureDisplayName-1741181545")
           .addAllObjectives(
               new ArrayList<
                   SearchModelDeploymentMonitoringStatsAnomaliesRequest
                       .StatsAnomaliesObjective>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .build();
   ApiFuture<ModelMonitoringStatsAnomalies> future =
       jobServiceClient
           .searchModelDeploymentMonitoringStatsAnomaliesPagedCallable()
           .futureCall(request);
   // Do something.
   for (ModelMonitoringStatsAnomalies element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • searchModelDeploymentMonitoringStatsAnomaliesCallable

      public final UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse> searchModelDeploymentMonitoringStatsAnomaliesCallable()
      Searches Model Monitoring Statistics generated within a given time window.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   SearchModelDeploymentMonitoringStatsAnomaliesRequest request =
       SearchModelDeploymentMonitoringStatsAnomaliesRequest.newBuilder()
           .setModelDeploymentMonitoringJob(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .setDeployedModelId("deployedModelId-1817547906")
           .setFeatureDisplayName("featureDisplayName-1741181545")
           .addAllObjectives(
               new ArrayList<
                   SearchModelDeploymentMonitoringStatsAnomaliesRequest
                       .StatsAnomaliesObjective>())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setStartTime(Timestamp.newBuilder().build())
           .setEndTime(Timestamp.newBuilder().build())
           .build();
   while (true) {
     SearchModelDeploymentMonitoringStatsAnomaliesResponse response =
         jobServiceClient.searchModelDeploymentMonitoringStatsAnomaliesCallable().call(request);
     for (ModelMonitoringStatsAnomalies element : response.getMonitoringStatsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getModelDeploymentMonitoringJob

      public final ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)
      Gets a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ModelDeploymentMonitoringJobName name =
       ModelDeploymentMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
   ModelDeploymentMonitoringJob response =
       jobServiceClient.getModelDeploymentMonitoringJob(name);
 }
      Parameters:
      name - Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • getModelDeploymentMonitoringJob

      public final ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(String name)
      Gets a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       ModelDeploymentMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
           .toString();
   ModelDeploymentMonitoringJob response =
       jobServiceClient.getModelDeploymentMonitoringJob(name);
 }
      Parameters:
      name - Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • getModelDeploymentMonitoringJob

      public final ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)
      Gets a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetModelDeploymentMonitoringJobRequest request =
       GetModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   ModelDeploymentMonitoringJob response =
       jobServiceClient.getModelDeploymentMonitoringJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getModelDeploymentMonitoringJobCallable

      public final UnaryCallable<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJobCallable()
      Gets a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetModelDeploymentMonitoringJobRequest request =
       GetModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   ApiFuture<ModelDeploymentMonitoringJob> future =
       jobServiceClient.getModelDeploymentMonitoringJobCallable().futureCall(request);
   // Do something.
   ModelDeploymentMonitoringJob response = future.get();
 }

    • listModelDeploymentMonitoringJobs

      public final JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse listModelDeploymentMonitoringJobs(LocationName parent)
      Lists ModelDeploymentMonitoringJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ModelDeploymentMonitoringJob element :
       jobServiceClient.listModelDeploymentMonitoringJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listModelDeploymentMonitoringJobs

      public final JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse listModelDeploymentMonitoringJobs(String parent)
      Lists ModelDeploymentMonitoringJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ModelDeploymentMonitoringJob element :
       jobServiceClient.listModelDeploymentMonitoringJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`
      Throws:
      ApiException - if the remote call fails

    • listModelDeploymentMonitoringJobs

      public final JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)
      Lists ModelDeploymentMonitoringJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListModelDeploymentMonitoringJobsRequest request =
       ListModelDeploymentMonitoringJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (ModelDeploymentMonitoringJob element :
       jobServiceClient.listModelDeploymentMonitoringJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listModelDeploymentMonitoringJobsPagedCallable

      public final UnaryCallable<ListModelDeploymentMonitoringJobsRequest,JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse> listModelDeploymentMonitoringJobsPagedCallable()
      Lists ModelDeploymentMonitoringJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListModelDeploymentMonitoringJobsRequest request =
       ListModelDeploymentMonitoringJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ModelDeploymentMonitoringJob> future =
       jobServiceClient.listModelDeploymentMonitoringJobsPagedCallable().futureCall(request);
   // Do something.
   for (ModelDeploymentMonitoringJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listModelDeploymentMonitoringJobsCallable

      public final UnaryCallable<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse> listModelDeploymentMonitoringJobsCallable()
      Lists ModelDeploymentMonitoringJobs in a Location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListModelDeploymentMonitoringJobsRequest request =
       ListModelDeploymentMonitoringJobsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListModelDeploymentMonitoringJobsResponse response =
         jobServiceClient.listModelDeploymentMonitoringJobsCallable().call(request);
     for (ModelDeploymentMonitoringJob element :
         response.getModelDeploymentMonitoringJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • updateModelDeploymentMonitoringJobAsync

      public final OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, com.google.protobuf.FieldMask updateMask)
      Updates a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ModelDeploymentMonitoringJob modelDeploymentMonitoringJob =
       ModelDeploymentMonitoringJob.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ModelDeploymentMonitoringJob response =
       jobServiceClient
           .updateModelDeploymentMonitoringJobAsync(modelDeploymentMonitoringJob, updateMask)
           .get();
 }
      Parameters:
      modelDeploymentMonitoringJob - Required. The model monitoring configuration which replaces the resource on the server.
      updateMask - Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset.

      Updatable fields:

      * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`

      Throws:
      ApiException - if the remote call fails

    • updateModelDeploymentMonitoringJobAsync

      public final OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request)
      Updates a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   UpdateModelDeploymentMonitoringJobRequest request =
       UpdateModelDeploymentMonitoringJobRequest.newBuilder()
           .setModelDeploymentMonitoringJob(ModelDeploymentMonitoringJob.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ModelDeploymentMonitoringJob response =
       jobServiceClient.updateModelDeploymentMonitoringJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateModelDeploymentMonitoringJobOperationCallable

      public final OperationCallable<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobOperationCallable()
      Updates a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   UpdateModelDeploymentMonitoringJobRequest request =
       UpdateModelDeploymentMonitoringJobRequest.newBuilder()
           .setModelDeploymentMonitoringJob(ModelDeploymentMonitoringJob.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<
           ModelDeploymentMonitoringJob, UpdateModelDeploymentMonitoringJobOperationMetadata>
       future =
           jobServiceClient
               .updateModelDeploymentMonitoringJobOperationCallable()
               .futureCall(request);
   // Do something.
   ModelDeploymentMonitoringJob response = future.get();
 }

    • updateModelDeploymentMonitoringJobCallable

      public final UnaryCallable<UpdateModelDeploymentMonitoringJobRequest,Operation> updateModelDeploymentMonitoringJobCallable()
      Updates a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   UpdateModelDeploymentMonitoringJobRequest request =
       UpdateModelDeploymentMonitoringJobRequest.newBuilder()
           .setModelDeploymentMonitoringJob(ModelDeploymentMonitoringJob.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       jobServiceClient.updateModelDeploymentMonitoringJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • deleteModelDeploymentMonitoringJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name)
      Deletes a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ModelDeploymentMonitoringJobName name =
       ModelDeploymentMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
   jobServiceClient.deleteModelDeploymentMonitoringJobAsync(name).get();
 }
      Parameters:
      name - Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteModelDeploymentMonitoringJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobAsync(String name)
      Deletes a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       ModelDeploymentMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
           .toString();
   jobServiceClient.deleteModelDeploymentMonitoringJobAsync(name).get();
 }
      Parameters:
      name - Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • deleteModelDeploymentMonitoringJobAsync

      public final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request)
      Deletes a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteModelDeploymentMonitoringJobRequest request =
       DeleteModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   jobServiceClient.deleteModelDeploymentMonitoringJobAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteModelDeploymentMonitoringJobOperationCallable

      public final OperationCallable<DeleteModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobOperationCallable()
      Deletes a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteModelDeploymentMonitoringJobRequest request =
       DeleteModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       jobServiceClient
           .deleteModelDeploymentMonitoringJobOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

    • deleteModelDeploymentMonitoringJobCallable

      public final UnaryCallable<DeleteModelDeploymentMonitoringJobRequest,Operation> deleteModelDeploymentMonitoringJobCallable()
      Deletes a ModelDeploymentMonitoringJob.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   DeleteModelDeploymentMonitoringJobRequest request =
       DeleteModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       jobServiceClient.deleteModelDeploymentMonitoringJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • pauseModelDeploymentMonitoringJob

      public final void pauseModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)
      Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ModelDeploymentMonitoringJobName name =
       ModelDeploymentMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
   jobServiceClient.pauseModelDeploymentMonitoringJob(name);
 }
      Parameters:
      name - Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • pauseModelDeploymentMonitoringJob

      public final void pauseModelDeploymentMonitoringJob(String name)
      Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       ModelDeploymentMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
           .toString();
   jobServiceClient.pauseModelDeploymentMonitoringJob(name);
 }
      Parameters:
      name - Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • pauseModelDeploymentMonitoringJob

      public final void pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request)
      Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   PauseModelDeploymentMonitoringJobRequest request =
       PauseModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   jobServiceClient.pauseModelDeploymentMonitoringJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • pauseModelDeploymentMonitoringJobCallable

      public final UnaryCallable<PauseModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty> pauseModelDeploymentMonitoringJobCallable()
      Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   PauseModelDeploymentMonitoringJobRequest request =
       PauseModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       jobServiceClient.pauseModelDeploymentMonitoringJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • resumeModelDeploymentMonitoringJob

      public final void resumeModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)
      Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ModelDeploymentMonitoringJobName name =
       ModelDeploymentMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
   jobServiceClient.resumeModelDeploymentMonitoringJob(name);
 }
      Parameters:
      name - Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • resumeModelDeploymentMonitoringJob

      public final void resumeModelDeploymentMonitoringJob(String name)
      Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   String name =
       ModelDeploymentMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
           .toString();
   jobServiceClient.resumeModelDeploymentMonitoringJob(name);
 }
      Parameters:
      name - Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
      Throws:
      ApiException - if the remote call fails

    • resumeModelDeploymentMonitoringJob

      public final void resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)
      Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ResumeModelDeploymentMonitoringJobRequest request =
       ResumeModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   jobServiceClient.resumeModelDeploymentMonitoringJob(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • resumeModelDeploymentMonitoringJobCallable

      public final UnaryCallable<ResumeModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty> resumeModelDeploymentMonitoringJobCallable()
      Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ResumeModelDeploymentMonitoringJobRequest request =
       ResumeModelDeploymentMonitoringJobRequest.newBuilder()
           .setName(
               ModelDeploymentMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       jobServiceClient.resumeModelDeploymentMonitoringJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listLocations

      public final JobServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : jobServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,JobServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       jobServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = jobServiceClient.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;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = jobServiceClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = jobServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

    • setIamPolicy

      public final Policy setIamPolicy(SetIamPolicyRequest request)
      Sets the access control policy on the specified resource. Replacesany existing policy.

      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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = jobServiceClient.setIamPolicy(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • setIamPolicyCallable

      public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
      Sets the access control policy on the specified resource. Replacesany existing policy.

      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 (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = jobServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • getIamPolicy

      public final Policy getIamPolicy(GetIamPolicyRequest request)
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = jobServiceClient.getIamPolicy(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getIamPolicyCallable

      public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = jobServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • testIamPermissions

      public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = jobServiceClient.testIamPermissions(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • testIamPermissionsCallable

      public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
      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.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       jobServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException