Class JobServiceClient (3.32.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of 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.

Inheritance

java.lang.Object > JobServiceClient

Static Methods

create()

public static final JobServiceClient create()

Constructs an instance of JobServiceClient with default settings.

Returns
TypeDescription
JobServiceClient
Exceptions
TypeDescription
IOException

create(JobServiceSettings settings)

public static final JobServiceClient create(JobServiceSettings settings)

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.

Parameter
NameDescription
settingsJobServiceSettings
Returns
TypeDescription
JobServiceClient
Exceptions
TypeDescription
IOException

create(JobServiceStub stub)

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

Parameter
NameDescription
stubJobServiceStub
Returns
TypeDescription
JobServiceClient

Constructors

JobServiceClient(JobServiceSettings settings)

protected JobServiceClient(JobServiceSettings settings)

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.

Parameter
NameDescription
settingsJobServiceSettings

JobServiceClient(JobServiceStub stub)

protected JobServiceClient(JobServiceStub stub)
Parameter
NameDescription
stubJobServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

cancelBatchPredictionJob(BatchPredictionJobName name)

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 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 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);
 }
 
Parameter
NameDescription
nameBatchPredictionJobName

Required. The name of the BatchPredictionJob to cancel. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)

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 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 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);
 }
 
Parameter
NameDescription
requestCancelBatchPredictionJobRequest

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

cancelBatchPredictionJob(String name)

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 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 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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the BatchPredictionJob to cancel. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

cancelBatchPredictionJobCallable()

public final UnaryCallable<CancelBatchPredictionJobRequest,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 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 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();
 }
 
Returns
TypeDescription
UnaryCallable<CancelBatchPredictionJobRequest,Empty>

cancelCustomJob(CancelCustomJobRequest request)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
requestCancelCustomJobRequest

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

cancelCustomJob(CustomJobName name)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
nameCustomJobName

Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

cancelCustomJob(String name)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

cancelCustomJobCallable()

public final UnaryCallable<CancelCustomJobRequest,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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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();
 }
 
Returns
TypeDescription
UnaryCallable<CancelCustomJobRequest,Empty>

cancelDataLabelingJob(CancelDataLabelingJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCancelDataLabelingJobRequest

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

cancelDataLabelingJob(DataLabelingJobName name)

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);
 }
 
Parameter
NameDescription
nameDataLabelingJobName

Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

cancelDataLabelingJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

cancelDataLabelingJobCallable()

public final UnaryCallable<CancelDataLabelingJobRequest,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();
 }
 
Returns
TypeDescription
UnaryCallable<CancelDataLabelingJobRequest,Empty>

cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
requestCancelHyperparameterTuningJobRequest

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

cancelHyperparameterTuningJob(HyperparameterTuningJobName name)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
nameHyperparameterTuningJobName

Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

cancelHyperparameterTuningJob(String name)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

cancelHyperparameterTuningJobCallable()

public final UnaryCallable<CancelHyperparameterTuningJobRequest,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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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();
 }
 
Returns
TypeDescription
UnaryCallable<CancelHyperparameterTuningJobRequest,Empty>

cancelNasJob(CancelNasJobRequest request)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
requestCancelNasJobRequest

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

cancelNasJob(NasJobName name)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
nameNasJobName

Required. The name of the NasJob to cancel. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

cancelNasJob(String name)

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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the NasJob to cancel. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

cancelNasJobCallable()

public final UnaryCallable<CancelNasJobRequest,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 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 value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and 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();
 }
 
Returns
TypeDescription
UnaryCallable<CancelNasJobRequest,Empty>

close()

public final void close()

createBatchPredictionJob(CreateBatchPredictionJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCreateBatchPredictionJobRequest

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

Returns
TypeDescription
BatchPredictionJob

createBatchPredictionJob(LocationName parent, BatchPredictionJob batchPredictionJob)

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
NameDescription
parentLocationName

Required. The resource name of the Location to create the BatchPredictionJob in. Format: projects/{project}/locations/{location}

batchPredictionJobBatchPredictionJob

Required. The BatchPredictionJob to create.

Returns
TypeDescription
BatchPredictionJob

createBatchPredictionJob(String parent, BatchPredictionJob batchPredictionJob)

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
NameDescription
parentString

Required. The resource name of the Location to create the BatchPredictionJob in. Format: projects/{project}/locations/{location}

batchPredictionJobBatchPredictionJob

Required. The BatchPredictionJob to create.

Returns
TypeDescription
BatchPredictionJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<CreateBatchPredictionJobRequest,BatchPredictionJob>

createCustomJob(CreateCustomJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCreateCustomJobRequest

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

Returns
TypeDescription
CustomJob

createCustomJob(LocationName parent, CustomJob customJob)

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
NameDescription
parentLocationName

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

customJobCustomJob

Required. The CustomJob to create.

Returns
TypeDescription
CustomJob

createCustomJob(String parent, CustomJob customJob)

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
NameDescription
parentString

Required. The resource name of the Location to create the CustomJob in. Format: projects/{project}/locations/{location}

customJobCustomJob

Required. The CustomJob to create.

Returns
TypeDescription
CustomJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<CreateCustomJobRequest,CustomJob>

createDataLabelingJob(CreateDataLabelingJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCreateDataLabelingJobRequest

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

Returns
TypeDescription
DataLabelingJob

createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob)

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
NameDescription
parentLocationName

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

dataLabelingJobDataLabelingJob

Required. The DataLabelingJob to create.

Returns
TypeDescription
DataLabelingJob

createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob)

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
NameDescription
parentString

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

dataLabelingJobDataLabelingJob

Required. The DataLabelingJob to create.

Returns
TypeDescription
DataLabelingJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<CreateDataLabelingJobRequest,DataLabelingJob>

createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCreateHyperparameterTuningJobRequest

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

Returns
TypeDescription
HyperparameterTuningJob

createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob)

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
NameDescription
parentLocationName

Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}

hyperparameterTuningJobHyperparameterTuningJob

Required. The HyperparameterTuningJob to create.

Returns
TypeDescription
HyperparameterTuningJob

createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob)

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
NameDescription
parentString

Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}

hyperparameterTuningJobHyperparameterTuningJob

Required. The HyperparameterTuningJob to create.

Returns
TypeDescription
HyperparameterTuningJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob>

createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCreateModelDeploymentMonitoringJobRequest

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

Returns
TypeDescription
ModelDeploymentMonitoringJob

createModelDeploymentMonitoringJob(LocationName parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob)

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
NameDescription
parentLocationName

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

modelDeploymentMonitoringJobModelDeploymentMonitoringJob

Required. The ModelDeploymentMonitoringJob to create

Returns
TypeDescription
ModelDeploymentMonitoringJob

createModelDeploymentMonitoringJob(String parent, ModelDeploymentMonitoringJob modelDeploymentMonitoringJob)

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
NameDescription
parentString

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

modelDeploymentMonitoringJobModelDeploymentMonitoringJob

Required. The ModelDeploymentMonitoringJob to create

Returns
TypeDescription
ModelDeploymentMonitoringJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob>

createNasJob(CreateNasJobRequest request)

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);
 }
 
Parameter
NameDescription
requestCreateNasJobRequest

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

Returns
TypeDescription
NasJob

createNasJob(LocationName parent, NasJob nasJob)

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
NameDescription
parentLocationName

Required. The resource name of the Location to create the NasJob in. Format: projects/{project}/locations/{location}

nasJobNasJob

Required. The NasJob to create.

Returns
TypeDescription
NasJob

createNasJob(String parent, NasJob nasJob)

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
NameDescription
parentString

Required. The resource name of the Location to create the NasJob in. Format: projects/{project}/locations/{location}

nasJobNasJob

Required. The NasJob to create.

Returns
TypeDescription
NasJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<CreateNasJobRequest,NasJob>

deleteBatchPredictionJobAsync(BatchPredictionJobName name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameBatchPredictionJobName

Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteBatchPredictionJobAsync(DeleteBatchPredictionJobRequest request)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
requestDeleteBatchPredictionJobRequest

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

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteBatchPredictionJobAsync(String name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameString

Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteBatchPredictionJobRequest,Operation>

deleteBatchPredictionJobOperationCallable()

public final OperationCallable<DeleteBatchPredictionJobRequest,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();
 }
 
Returns
TypeDescription
OperationCallable<DeleteBatchPredictionJobRequest,Empty,DeleteOperationMetadata>

deleteCustomJobAsync(CustomJobName name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameCustomJobName

Required. The name of the CustomJob resource to be deleted. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteCustomJobAsync(DeleteCustomJobRequest request)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
requestDeleteCustomJobRequest

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

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteCustomJobAsync(String name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameString

Required. The name of the CustomJob resource to be deleted. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteCustomJobRequest,Operation>

deleteCustomJobOperationCallable()

public final OperationCallable<DeleteCustomJobRequest,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();
 }
 
Returns
TypeDescription
OperationCallable<DeleteCustomJobRequest,Empty,DeleteOperationMetadata>

deleteDataLabelingJobAsync(DataLabelingJobName name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameDataLabelingJobName

Required. The name of the DataLabelingJob to be deleted. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
requestDeleteDataLabelingJobRequest

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

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteDataLabelingJobAsync(String name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameString

Required. The name of the DataLabelingJob to be deleted. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteDataLabelingJobRequest,Operation>

deleteDataLabelingJobOperationCallable()

public final OperationCallable<DeleteDataLabelingJobRequest,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();
 }
 
Returns
TypeDescription
OperationCallable<DeleteDataLabelingJobRequest,Empty,DeleteOperationMetadata>

deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
requestDeleteHyperparameterTuningJobRequest

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

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameHyperparameterTuningJobName

Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteHyperparameterTuningJobAsync(String name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameString

Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteHyperparameterTuningJobRequest,Operation>

deleteHyperparameterTuningJobOperationCallable()

public final OperationCallable<DeleteHyperparameterTuningJobRequest,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();
 }
 
Returns
TypeDescription
OperationCallable<DeleteHyperparameterTuningJobRequest,Empty,DeleteOperationMetadata>

deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
requestDeleteModelDeploymentMonitoringJobRequest

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

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameModelDeploymentMonitoringJobName

Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelDeploymentMonitoringJobAsync(String name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteModelDeploymentMonitoringJobRequest,Operation>

deleteModelDeploymentMonitoringJobOperationCallable()

public final OperationCallable<DeleteModelDeploymentMonitoringJobRequest,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();
 }
 
Returns
TypeDescription
OperationCallable<DeleteModelDeploymentMonitoringJobRequest,Empty,DeleteOperationMetadata>

deleteNasJobAsync(DeleteNasJobRequest request)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
requestDeleteNasJobRequest

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

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteNasJobAsync(NasJobName name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameNasJobName

Required. The name of the NasJob resource to be deleted. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteNasJobAsync(String name)

public final OperationFuture<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();
 }
 
Parameter
NameDescription
nameString

Required. The name of the NasJob resource to be deleted. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteNasJobRequest,Operation>

deleteNasJobOperationCallable()

public final OperationCallable<DeleteNasJobRequest,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();
 }
 
Returns
TypeDescription
OperationCallable<DeleteNasJobRequest,Empty,DeleteOperationMetadata>

getBatchPredictionJob(BatchPredictionJobName name)

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);
 }
 
Parameter
NameDescription
nameBatchPredictionJobName

Required. The name of the BatchPredictionJob resource. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Returns
TypeDescription
BatchPredictionJob

getBatchPredictionJob(GetBatchPredictionJobRequest request)

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);
 }
 
Parameter
NameDescription
requestGetBatchPredictionJobRequest

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

Returns
TypeDescription
BatchPredictionJob

getBatchPredictionJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the BatchPredictionJob resource. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Returns
TypeDescription
BatchPredictionJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetBatchPredictionJobRequest,BatchPredictionJob>

getCustomJob(CustomJobName name)

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);
 }
 
Parameter
NameDescription
nameCustomJobName

Required. The name of the CustomJob resource. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Returns
TypeDescription
CustomJob

getCustomJob(GetCustomJobRequest request)

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);
 }
 
Parameter
NameDescription
requestGetCustomJobRequest

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

Returns
TypeDescription
CustomJob

getCustomJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the CustomJob resource. Format: projects/{project}/locations/{location}/customJobs/{custom_job}

Returns
TypeDescription
CustomJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetCustomJobRequest,CustomJob>

getDataLabelingJob(DataLabelingJobName name)

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);
 }
 
Parameter
NameDescription
nameDataLabelingJobName

Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Returns
TypeDescription
DataLabelingJob

getDataLabelingJob(GetDataLabelingJobRequest request)

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);
 }
 
Parameter
NameDescription
requestGetDataLabelingJobRequest

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

Returns
TypeDescription
DataLabelingJob

getDataLabelingJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Returns
TypeDescription
DataLabelingJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetDataLabelingJobRequest,DataLabelingJob>

getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

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);
 }
 
Parameter
NameDescription
requestGetHyperparameterTuningJobRequest

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

Returns
TypeDescription
HyperparameterTuningJob

getHyperparameterTuningJob(HyperparameterTuningJobName name)

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);
 }
 
Parameter
NameDescription
nameHyperparameterTuningJobName

Required. The name of the HyperparameterTuningJob resource. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns
TypeDescription
HyperparameterTuningJob

getHyperparameterTuningJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the HyperparameterTuningJob resource. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns
TypeDescription
HyperparameterTuningJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetHyperparameterTuningJobRequest,HyperparameterTuningJob>

getIamPolicy(GetIamPolicyRequest request)

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);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest

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

Returns
TypeDescription
com.google.iam.v1.Policy

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();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


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

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

Returns
TypeDescription
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


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

getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

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);
 }
 
Parameter
NameDescription
requestGetModelDeploymentMonitoringJobRequest

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

Returns
TypeDescription
ModelDeploymentMonitoringJob

getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)

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);
 }
 
Parameter
NameDescription
nameModelDeploymentMonitoringJobName

Required. The resource name of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Returns
TypeDescription
ModelDeploymentMonitoringJob

getModelDeploymentMonitoringJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Returns
TypeDescription
ModelDeploymentMonitoringJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob>

getNasJob(GetNasJobRequest request)

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);
 }
 
Parameter
NameDescription
requestGetNasJobRequest

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

Returns
TypeDescription
NasJob

getNasJob(NasJobName name)

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);
 }
 
Parameter
NameDescription
nameNasJobName

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Returns
TypeDescription
NasJob

getNasJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Returns
TypeDescription
NasJob

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetNasJobRequest,NasJob>

getNasTrialDetail(GetNasTrialDetailRequest request)

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);
 }
 
Parameter
NameDescription
requestGetNasTrialDetailRequest

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

Returns
TypeDescription
NasTrialDetail

getNasTrialDetail(NasTrialDetailName name)

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);
 }
 
Parameter
NameDescription
nameNasTrialDetailName

Required. The name of the NasTrialDetail resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}

Returns
TypeDescription
NasTrialDetail

getNasTrialDetail(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The name of the NasTrialDetail resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}

Returns
TypeDescription
NasTrialDetail

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();
 }
 
Returns
TypeDescription
UnaryCallable<GetNasTrialDetailRequest,NasTrialDetail>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
TypeDescription
OperationsClient

getSettings()

public final JobServiceSettings getSettings()
Returns
TypeDescription
JobServiceSettings

getStub()

public JobServiceStub getStub()
Returns
TypeDescription
JobServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListBatchPredictionJobsRequest

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

Returns
TypeDescription
JobServiceClient.ListBatchPredictionJobsPagedResponse

listBatchPredictionJobs(LocationName parent)

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);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListBatchPredictionJobsPagedResponse

listBatchPredictionJobs(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListBatchPredictionJobsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListBatchPredictionJobsRequest,ListBatchPredictionJobsPagedResponse>

listCustomJobs(ListCustomJobsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListCustomJobsRequest

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

Returns
TypeDescription
JobServiceClient.ListCustomJobsPagedResponse

listCustomJobs(LocationName parent)

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);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListCustomJobsPagedResponse

listCustomJobs(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListCustomJobsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListCustomJobsRequest,ListCustomJobsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListCustomJobsRequest,ListCustomJobsPagedResponse>

listDataLabelingJobs(ListDataLabelingJobsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListDataLabelingJobsRequest

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

Returns
TypeDescription
JobServiceClient.ListDataLabelingJobsPagedResponse

listDataLabelingJobs(LocationName parent)

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);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListDataLabelingJobsPagedResponse

listDataLabelingJobs(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent of the DataLabelingJob. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListDataLabelingJobsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListDataLabelingJobsRequest,ListDataLabelingJobsPagedResponse>

listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListHyperparameterTuningJobsRequest

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

Returns
TypeDescription
JobServiceClient.ListHyperparameterTuningJobsPagedResponse

listHyperparameterTuningJobs(LocationName parent)

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);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListHyperparameterTuningJobsPagedResponse

listHyperparameterTuningJobs(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListHyperparameterTuningJobsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsPagedResponse>

listLocations(ListLocationsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestcom.google.cloud.location.ListLocationsRequest

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

Returns
TypeDescription
JobServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListModelDeploymentMonitoringJobsRequest

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

Returns
TypeDescription
JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse

listModelDeploymentMonitoringJobs(LocationName parent)

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);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse

listModelDeploymentMonitoringJobs(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsPagedResponse>

listNasJobs(ListNasJobsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListNasJobsRequest

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

Returns
TypeDescription
JobServiceClient.ListNasJobsPagedResponse

listNasJobs(LocationName parent)

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);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The resource name of the Location to list the NasJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListNasJobsPagedResponse

listNasJobs(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the Location to list the NasJobs from. Format: projects/{project}/locations/{location}

Returns
TypeDescription
JobServiceClient.ListNasJobsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListNasJobsRequest,ListNasJobsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListNasJobsRequest,ListNasJobsPagedResponse>

listNasTrialDetails(ListNasTrialDetailsRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestListNasTrialDetailsRequest

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

Returns
TypeDescription
JobServiceClient.ListNasTrialDetailsPagedResponse

listNasTrialDetails(NasJobName parent)

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);
   }
 }
 
Parameter
NameDescription
parentNasJobName

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Returns
TypeDescription
JobServiceClient.ListNasTrialDetailsPagedResponse

listNasTrialDetails(String parent)

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);
   }
 }
 
Parameter
NameDescription
parentString

Required. The name of the NasJob resource. Format: projects/{project}/locations/{location}/nasJobs/{nas_job}

Returns
TypeDescription
JobServiceClient.ListNasTrialDetailsPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListNasTrialDetailsRequest,ListNasTrialDetailsResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListNasTrialDetailsRequest,ListNasTrialDetailsPagedResponse>

pauseModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)

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 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);
 }
 
Parameter
NameDescription
nameModelDeploymentMonitoringJobName

Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request)

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 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);
 }
 
Parameter
NameDescription
requestPauseModelDeploymentMonitoringJobRequest

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

pauseModelDeploymentMonitoringJob(String name)

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 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);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

pauseModelDeploymentMonitoringJobCallable()

public final UnaryCallable<PauseModelDeploymentMonitoringJobRequest,Empty> pauseModelDeploymentMonitoringJobCallable()

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark 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();
 }
 
Returns
TypeDescription
UnaryCallable<PauseModelDeploymentMonitoringJobRequest,Empty>

resumeModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)

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);
 }
 
Parameter
NameDescription
nameModelDeploymentMonitoringJobName

Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)

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);
 }
 
Parameter
NameDescription
requestResumeModelDeploymentMonitoringJobRequest

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

resumeModelDeploymentMonitoringJob(String name)

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);
 }
 
Parameter
NameDescription
nameString

Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

resumeModelDeploymentMonitoringJobCallable()

public final UnaryCallable<ResumeModelDeploymentMonitoringJobRequest,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();
 }
 
Returns
TypeDescription
UnaryCallable<ResumeModelDeploymentMonitoringJobRequest,Empty>

searchModelDeploymentMonitoringStatsAnomalies(ModelDeploymentMonitoringJobName modelDeploymentMonitoringJob, String deployedModelId)

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
NameDescription
modelDeploymentMonitoringJobModelDeploymentMonitoringJobName

Required. ModelDeploymentMonitoring Job resource name. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

deployedModelIdString

Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].

Returns
TypeDescription
JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse

searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

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);
   }
 }
 
Parameter
NameDescription
requestSearchModelDeploymentMonitoringStatsAnomaliesRequest

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

Returns
TypeDescription
JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse

searchModelDeploymentMonitoringStatsAnomalies(String modelDeploymentMonitoringJob, String deployedModelId)

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
NameDescription
modelDeploymentMonitoringJobString

Required. ModelDeploymentMonitoring Job resource name. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

deployedModelIdString

Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].

Returns
TypeDescription
JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse

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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse>

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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying 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);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest

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

Returns
TypeDescription
com.google.iam.v1.Policy

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying 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();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

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);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest

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

Returns
TypeDescription
com.google.iam.v1.TestIamPermissionsResponse

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();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, FieldMask updateMask)

public final OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, 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
NameDescription
modelDeploymentMonitoringJobModelDeploymentMonitoringJob

Required. The model monitoring configuration which replaces the resource on the server.

updateMaskFieldMask

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

Returns
TypeDescription
OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata>

updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request)

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();
 }
 
Parameter
NameDescription
requestUpdateModelDeploymentMonitoringJobRequest

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

Returns
TypeDescription
OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata>

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();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateModelDeploymentMonitoringJobRequest,Operation>

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();
 }
 
Returns
TypeDescription
OperationCallable<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata>