- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public class JobServiceClient implements BackgroundResource
Service Description: A service for creating and managing Vertex AI's jobs.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
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:
- 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.
- 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.
- 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:
JobServiceSettings jobServiceSettings =
JobServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);
To customize the endpoint:
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.
Implements
BackgroundResourceStatic Methods
create()
public static final JobServiceClient create()
Constructs an instance of JobServiceClient with default settings.
Type | Description |
JobServiceClient |
Type | Description |
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.
Name | Description |
settings | JobServiceSettings |
Type | Description |
JobServiceClient |
Type | Description |
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).
Name | Description |
stub | JobServiceStub |
Type | Description |
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.
Name | Description |
settings | JobServiceSettings |
JobServiceClient(JobServiceStub stub)
protected JobServiceClient(JobServiceStub stub)
Name | Description |
stub | JobServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
BatchPredictionJobName name =
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
jobServiceClient.cancelBatchPredictionJob(name);
}
Name | Description |
name | BatchPredictionJobName Required. The name of the BatchPredictionJob to cancel. Format:
|
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CancelBatchPredictionJobRequest request =
CancelBatchPredictionJobRequest.newBuilder()
.setName(
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
.toString())
.build();
jobServiceClient.cancelBatchPredictionJob(request);
}
Name | Description |
request | CancelBatchPredictionJobRequest 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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]").toString();
jobServiceClient.cancelBatchPredictionJob(name);
}
Name | Description |
name | String Required. The name of the BatchPredictionJob to cancel. Format:
|
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:
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();
}
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CancelCustomJobRequest request =
CancelCustomJobRequest.newBuilder()
.setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
.build();
jobServiceClient.cancelCustomJob(request);
}
Name | Description |
request | CancelCustomJobRequest 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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CustomJobName name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
jobServiceClient.cancelCustomJob(name);
}
Name | Description |
name | CustomJobName Required. The name of the CustomJob to cancel. Format:
|
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString();
jobServiceClient.cancelCustomJob(name);
}
Name | Description |
name | String Required. The name of the CustomJob to cancel. Format:
|
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:
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();
}
Type | Description |
UnaryCallable<CancelCustomJobRequest,Empty> |
cancelDataLabelingJob(CancelDataLabelingJobRequest request)
public final void cancelDataLabelingJob(CancelDataLabelingJobRequest request)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CancelDataLabelingJobRequest request =
CancelDataLabelingJobRequest.newBuilder()
.setName(
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
.toString())
.build();
jobServiceClient.cancelDataLabelingJob(request);
}
Name | Description |
request | CancelDataLabelingJobRequest 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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DataLabelingJobName name =
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
jobServiceClient.cancelDataLabelingJob(name);
}
Name | Description |
name | DataLabelingJobName Required. The name of the DataLabelingJob. Format:
|
cancelDataLabelingJob(String name)
public final void cancelDataLabelingJob(String name)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]").toString();
jobServiceClient.cancelDataLabelingJob(name);
}
Name | Description |
name | String Required. The name of the DataLabelingJob. Format:
|
cancelDataLabelingJobCallable()
public final UnaryCallable<CancelDataLabelingJobRequest,Empty> cancelDataLabelingJobCallable()
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Sample code:
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();
}
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CancelHyperparameterTuningJobRequest request =
CancelHyperparameterTuningJobRequest.newBuilder()
.setName(
HyperparameterTuningJobName.of(
"[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
.toString())
.build();
jobServiceClient.cancelHyperparameterTuningJob(request);
}
Name | Description |
request | CancelHyperparameterTuningJobRequest 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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
HyperparameterTuningJobName name =
HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
jobServiceClient.cancelHyperparameterTuningJob(name);
}
Name | Description |
name | HyperparameterTuningJobName Required. The name of the HyperparameterTuningJob to cancel. Format:
|
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
.toString();
jobServiceClient.cancelHyperparameterTuningJob(name);
}
Name | Description |
name | String Required. The name of the HyperparameterTuningJob to cancel. Format:
|
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:
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();
}
Type | Description |
UnaryCallable<CancelHyperparameterTuningJobRequest,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:
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);
}
Name | Description |
request | CreateBatchPredictionJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
BatchPredictionJob batchPredictionJob = BatchPredictionJob.newBuilder().build();
BatchPredictionJob response =
jobServiceClient.createBatchPredictionJob(parent, batchPredictionJob);
}
Name | Description |
parent | LocationName Required. The resource name of the Location to create the BatchPredictionJob in.
Format: |
batchPredictionJob | BatchPredictionJob Required. The BatchPredictionJob to create. |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
BatchPredictionJob batchPredictionJob = BatchPredictionJob.newBuilder().build();
BatchPredictionJob response =
jobServiceClient.createBatchPredictionJob(parent, batchPredictionJob);
}
Name | Description |
parent | String Required. The resource name of the Location to create the BatchPredictionJob in.
Format: |
batchPredictionJob | BatchPredictionJob Required. The BatchPredictionJob to create. |
Type | Description |
BatchPredictionJob |
createBatchPredictionJobCallable()
public final UnaryCallable<CreateBatchPredictionJobRequest,BatchPredictionJob> createBatchPredictionJobCallable()
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Sample code:
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();
}
Type | Description |
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:
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);
}
Name | Description |
request | CreateCustomJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
CustomJob customJob = CustomJob.newBuilder().build();
CustomJob response = jobServiceClient.createCustomJob(parent, customJob);
}
Name | Description |
parent | LocationName Required. The resource name of the Location to create the CustomJob in. Format:
|
customJob | CustomJob Required. The CustomJob to create. |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
CustomJob customJob = CustomJob.newBuilder().build();
CustomJob response = jobServiceClient.createCustomJob(parent, customJob);
}
Name | Description |
parent | String Required. The resource name of the Location to create the CustomJob in. Format:
|
customJob | CustomJob Required. The CustomJob to create. |
Type | Description |
CustomJob |
createCustomJobCallable()
public final UnaryCallable<CreateCustomJobRequest,CustomJob> createCustomJobCallable()
Creates a CustomJob. A created CustomJob right away will be attempted to be run.
Sample code:
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();
}
Type | Description |
UnaryCallable<CreateCustomJobRequest,CustomJob> |
createDataLabelingJob(CreateDataLabelingJobRequest request)
public final DataLabelingJob createDataLabelingJob(CreateDataLabelingJobRequest request)
Creates a DataLabelingJob.
Sample code:
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);
}
Name | Description |
request | CreateDataLabelingJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
DataLabelingJob |
createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob)
public final DataLabelingJob createDataLabelingJob(LocationName parent, DataLabelingJob dataLabelingJob)
Creates a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
DataLabelingJob dataLabelingJob = DataLabelingJob.newBuilder().build();
DataLabelingJob response = jobServiceClient.createDataLabelingJob(parent, dataLabelingJob);
}
Name | Description |
parent | LocationName Required. The parent of the DataLabelingJob. Format:
|
dataLabelingJob | DataLabelingJob Required. The DataLabelingJob to create. |
Type | Description |
DataLabelingJob |
createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob)
public final DataLabelingJob createDataLabelingJob(String parent, DataLabelingJob dataLabelingJob)
Creates a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
DataLabelingJob dataLabelingJob = DataLabelingJob.newBuilder().build();
DataLabelingJob response = jobServiceClient.createDataLabelingJob(parent, dataLabelingJob);
}
Name | Description |
parent | String Required. The parent of the DataLabelingJob. Format:
|
dataLabelingJob | DataLabelingJob Required. The DataLabelingJob to create. |
Type | Description |
DataLabelingJob |
createDataLabelingJobCallable()
public final UnaryCallable<CreateDataLabelingJobRequest,DataLabelingJob> createDataLabelingJobCallable()
Creates a DataLabelingJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<CreateDataLabelingJobRequest,DataLabelingJob> |
createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)
public final HyperparameterTuningJob createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)
Creates a HyperparameterTuningJob
Sample code:
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);
}
Name | Description |
request | CreateHyperparameterTuningJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
HyperparameterTuningJob |
createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob)
public final HyperparameterTuningJob createHyperparameterTuningJob(LocationName parent, HyperparameterTuningJob hyperparameterTuningJob)
Creates a HyperparameterTuningJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
HyperparameterTuningJob hyperparameterTuningJob =
HyperparameterTuningJob.newBuilder().build();
HyperparameterTuningJob response =
jobServiceClient.createHyperparameterTuningJob(parent, hyperparameterTuningJob);
}
Name | Description |
parent | LocationName Required. The resource name of the Location to create the HyperparameterTuningJob
in. Format: |
hyperparameterTuningJob | HyperparameterTuningJob Required. The HyperparameterTuningJob to create. |
Type | Description |
HyperparameterTuningJob |
createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob)
public final HyperparameterTuningJob createHyperparameterTuningJob(String parent, HyperparameterTuningJob hyperparameterTuningJob)
Creates a HyperparameterTuningJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
HyperparameterTuningJob hyperparameterTuningJob =
HyperparameterTuningJob.newBuilder().build();
HyperparameterTuningJob response =
jobServiceClient.createHyperparameterTuningJob(parent, hyperparameterTuningJob);
}
Name | Description |
parent | String Required. The resource name of the Location to create the HyperparameterTuningJob
in. Format: |
hyperparameterTuningJob | HyperparameterTuningJob Required. The HyperparameterTuningJob to create. |
Type | Description |
HyperparameterTuningJob |
createHyperparameterTuningJobCallable()
public final UnaryCallable<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob> createHyperparameterTuningJobCallable()
Creates a HyperparameterTuningJob
Sample code:
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();
}
Type | Description |
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:
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);
}
Name | Description |
request | CreateModelDeploymentMonitoringJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
ModelDeploymentMonitoringJob modelDeploymentMonitoringJob =
ModelDeploymentMonitoringJob.newBuilder().build();
ModelDeploymentMonitoringJob response =
jobServiceClient.createModelDeploymentMonitoringJob(parent, modelDeploymentMonitoringJob);
}
Name | Description |
parent | LocationName Required. The parent of the ModelDeploymentMonitoringJob. Format:
|
modelDeploymentMonitoringJob | ModelDeploymentMonitoringJob Required. The ModelDeploymentMonitoringJob to create |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
ModelDeploymentMonitoringJob modelDeploymentMonitoringJob =
ModelDeploymentMonitoringJob.newBuilder().build();
ModelDeploymentMonitoringJob response =
jobServiceClient.createModelDeploymentMonitoringJob(parent, modelDeploymentMonitoringJob);
}
Name | Description |
parent | String Required. The parent of the ModelDeploymentMonitoringJob. Format:
|
modelDeploymentMonitoringJob | ModelDeploymentMonitoringJob Required. The ModelDeploymentMonitoringJob to create |
Type | Description |
ModelDeploymentMonitoringJob |
createModelDeploymentMonitoringJobCallable()
public final UnaryCallable<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJobCallable()
Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
Sample code:
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();
}
Type | Description |
UnaryCallable<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
BatchPredictionJobName name =
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
jobServiceClient.deleteBatchPredictionJobAsync(name).get();
}
Name | Description |
name | BatchPredictionJobName Required. The name of the BatchPredictionJob resource to be deleted. Format:
|
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DeleteBatchPredictionJobRequest request =
DeleteBatchPredictionJobRequest.newBuilder()
.setName(
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
.toString())
.build();
jobServiceClient.deleteBatchPredictionJobAsync(request).get();
}
Name | Description |
request | DeleteBatchPredictionJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]").toString();
jobServiceClient.deleteBatchPredictionJobAsync(name).get();
}
Name | Description |
name | String Required. The name of the BatchPredictionJob resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteBatchPredictionJobCallable()
public final UnaryCallable<DeleteBatchPredictionJobRequest,Operation> deleteBatchPredictionJobCallable()
Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
Sample code:
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();
}
Type | Description |
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:
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();
}
Type | Description |
OperationCallable<DeleteBatchPredictionJobRequest,Empty,DeleteOperationMetadata> |
deleteCustomJobAsync(CustomJobName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteCustomJobAsync(CustomJobName name)
Deletes a CustomJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CustomJobName name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
jobServiceClient.deleteCustomJobAsync(name).get();
}
Name | Description |
name | CustomJobName Required. The name of the CustomJob resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteCustomJobAsync(DeleteCustomJobRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteCustomJobAsync(DeleteCustomJobRequest request)
Deletes a CustomJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DeleteCustomJobRequest request =
DeleteCustomJobRequest.newBuilder()
.setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
.build();
jobServiceClient.deleteCustomJobAsync(request).get();
}
Name | Description |
request | DeleteCustomJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteCustomJobAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteCustomJobAsync(String name)
Deletes a CustomJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString();
jobServiceClient.deleteCustomJobAsync(name).get();
}
Name | Description |
name | String Required. The name of the CustomJob resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteCustomJobCallable()
public final UnaryCallable<DeleteCustomJobRequest,Operation> deleteCustomJobCallable()
Deletes a CustomJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<DeleteCustomJobRequest,Operation> |
deleteCustomJobOperationCallable()
public final OperationCallable<DeleteCustomJobRequest,Empty,DeleteOperationMetadata> deleteCustomJobOperationCallable()
Deletes a CustomJob.
Sample code:
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();
}
Type | Description |
OperationCallable<DeleteCustomJobRequest,Empty,DeleteOperationMetadata> |
deleteDataLabelingJobAsync(DataLabelingJobName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDataLabelingJobAsync(DataLabelingJobName name)
Deletes a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DataLabelingJobName name =
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
jobServiceClient.deleteDataLabelingJobAsync(name).get();
}
Name | Description |
name | DataLabelingJobName Required. The name of the DataLabelingJob to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDataLabelingJobAsync(DeleteDataLabelingJobRequest request)
Deletes a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DeleteDataLabelingJobRequest request =
DeleteDataLabelingJobRequest.newBuilder()
.setName(
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
.toString())
.build();
jobServiceClient.deleteDataLabelingJobAsync(request).get();
}
Name | Description |
request | DeleteDataLabelingJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDataLabelingJobAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDataLabelingJobAsync(String name)
Deletes a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]").toString();
jobServiceClient.deleteDataLabelingJobAsync(name).get();
}
Name | Description |
name | String Required. The name of the DataLabelingJob to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDataLabelingJobCallable()
public final UnaryCallable<DeleteDataLabelingJobRequest,Operation> deleteDataLabelingJobCallable()
Deletes a DataLabelingJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<DeleteDataLabelingJobRequest,Operation> |
deleteDataLabelingJobOperationCallable()
public final OperationCallable<DeleteDataLabelingJobRequest,Empty,DeleteOperationMetadata> deleteDataLabelingJobOperationCallable()
Deletes a DataLabelingJob.
Sample code:
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();
}
Type | Description |
OperationCallable<DeleteDataLabelingJobRequest,Empty,DeleteOperationMetadata> |
deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobAsync(DeleteHyperparameterTuningJobRequest request)
Deletes a HyperparameterTuningJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DeleteHyperparameterTuningJobRequest request =
DeleteHyperparameterTuningJobRequest.newBuilder()
.setName(
HyperparameterTuningJobName.of(
"[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
.toString())
.build();
jobServiceClient.deleteHyperparameterTuningJobAsync(request).get();
}
Name | Description |
request | DeleteHyperparameterTuningJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobAsync(HyperparameterTuningJobName name)
Deletes a HyperparameterTuningJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
HyperparameterTuningJobName name =
HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
jobServiceClient.deleteHyperparameterTuningJobAsync(name).get();
}
Name | Description |
name | HyperparameterTuningJobName Required. The name of the HyperparameterTuningJob resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteHyperparameterTuningJobAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobAsync(String name)
Deletes a HyperparameterTuningJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
.toString();
jobServiceClient.deleteHyperparameterTuningJobAsync(name).get();
}
Name | Description |
name | String Required. The name of the HyperparameterTuningJob resource to be deleted. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteHyperparameterTuningJobCallable()
public final UnaryCallable<DeleteHyperparameterTuningJobRequest,Operation> deleteHyperparameterTuningJobCallable()
Deletes a HyperparameterTuningJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<DeleteHyperparameterTuningJobRequest,Operation> |
deleteHyperparameterTuningJobOperationCallable()
public final OperationCallable<DeleteHyperparameterTuningJobRequest,Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobOperationCallable()
Deletes a HyperparameterTuningJob.
Sample code:
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();
}
Type | Description |
OperationCallable<DeleteHyperparameterTuningJobRequest,Empty,DeleteOperationMetadata> |
deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobAsync(DeleteModelDeploymentMonitoringJobRequest request)
Deletes a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DeleteModelDeploymentMonitoringJobRequest request =
DeleteModelDeploymentMonitoringJobRequest.newBuilder()
.setName(
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString())
.build();
jobServiceClient.deleteModelDeploymentMonitoringJobAsync(request).get();
}
Name | Description |
request | DeleteModelDeploymentMonitoringJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJobName name)
Deletes a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
ModelDeploymentMonitoringJobName name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
jobServiceClient.deleteModelDeploymentMonitoringJobAsync(name).get();
}
Name | Description |
name | ModelDeploymentMonitoringJobName Required. The resource name of the model monitoring job to delete. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteModelDeploymentMonitoringJobAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobAsync(String name)
Deletes a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString();
jobServiceClient.deleteModelDeploymentMonitoringJobAsync(name).get();
}
Name | Description |
name | String Required. The resource name of the model monitoring job to delete. Format:
|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteModelDeploymentMonitoringJobCallable()
public final UnaryCallable<DeleteModelDeploymentMonitoringJobRequest,Operation> deleteModelDeploymentMonitoringJobCallable()
Deletes a ModelDeploymentMonitoringJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<DeleteModelDeploymentMonitoringJobRequest,Operation> |
deleteModelDeploymentMonitoringJobOperationCallable()
public final OperationCallable<DeleteModelDeploymentMonitoringJobRequest,Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobOperationCallable()
Deletes a ModelDeploymentMonitoringJob.
Sample code:
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();
}
Type | Description |
OperationCallable<DeleteModelDeploymentMonitoringJobRequest,Empty,DeleteOperationMetadata> |
getBatchPredictionJob(BatchPredictionJobName name)
public final BatchPredictionJob getBatchPredictionJob(BatchPredictionJobName name)
Gets a BatchPredictionJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
BatchPredictionJobName name =
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]");
BatchPredictionJob response = jobServiceClient.getBatchPredictionJob(name);
}
Name | Description |
name | BatchPredictionJobName Required. The name of the BatchPredictionJob resource. Format:
|
Type | Description |
BatchPredictionJob |
getBatchPredictionJob(GetBatchPredictionJobRequest request)
public final BatchPredictionJob getBatchPredictionJob(GetBatchPredictionJobRequest request)
Gets a BatchPredictionJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
GetBatchPredictionJobRequest request =
GetBatchPredictionJobRequest.newBuilder()
.setName(
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]")
.toString())
.build();
BatchPredictionJob response = jobServiceClient.getBatchPredictionJob(request);
}
Name | Description |
request | GetBatchPredictionJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
BatchPredictionJob |
getBatchPredictionJob(String name)
public final BatchPredictionJob getBatchPredictionJob(String name)
Gets a BatchPredictionJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
BatchPredictionJobName.of("[PROJECT]", "[LOCATION]", "[BATCH_PREDICTION_JOB]").toString();
BatchPredictionJob response = jobServiceClient.getBatchPredictionJob(name);
}
Name | Description |
name | String Required. The name of the BatchPredictionJob resource. Format:
|
Type | Description |
BatchPredictionJob |
getBatchPredictionJobCallable()
public final UnaryCallable<GetBatchPredictionJobRequest,BatchPredictionJob> getBatchPredictionJobCallable()
Gets a BatchPredictionJob
Sample code:
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();
}
Type | Description |
UnaryCallable<GetBatchPredictionJobRequest,BatchPredictionJob> |
getCustomJob(CustomJobName name)
public final CustomJob getCustomJob(CustomJobName name)
Gets a CustomJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
CustomJobName name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]");
CustomJob response = jobServiceClient.getCustomJob(name);
}
Name | Description |
name | CustomJobName Required. The name of the CustomJob resource. Format:
|
Type | Description |
CustomJob |
getCustomJob(GetCustomJobRequest request)
public final CustomJob getCustomJob(GetCustomJobRequest request)
Gets a CustomJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
GetCustomJobRequest request =
GetCustomJobRequest.newBuilder()
.setName(CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString())
.build();
CustomJob response = jobServiceClient.getCustomJob(request);
}
Name | Description |
request | GetCustomJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
CustomJob |
getCustomJob(String name)
public final CustomJob getCustomJob(String name)
Gets a CustomJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name = CustomJobName.of("[PROJECT]", "[LOCATION]", "[CUSTOM_JOB]").toString();
CustomJob response = jobServiceClient.getCustomJob(name);
}
Name | Description |
name | String Required. The name of the CustomJob resource. Format:
|
Type | Description |
CustomJob |
getCustomJobCallable()
public final UnaryCallable<GetCustomJobRequest,CustomJob> getCustomJobCallable()
Gets a CustomJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetCustomJobRequest,CustomJob> |
getDataLabelingJob(DataLabelingJobName name)
public final DataLabelingJob getDataLabelingJob(DataLabelingJobName name)
Gets a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
DataLabelingJobName name =
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]");
DataLabelingJob response = jobServiceClient.getDataLabelingJob(name);
}
Name | Description |
name | DataLabelingJobName Required. The name of the DataLabelingJob. Format:
|
Type | Description |
DataLabelingJob |
getDataLabelingJob(GetDataLabelingJobRequest request)
public final DataLabelingJob getDataLabelingJob(GetDataLabelingJobRequest request)
Gets a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
GetDataLabelingJobRequest request =
GetDataLabelingJobRequest.newBuilder()
.setName(
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]")
.toString())
.build();
DataLabelingJob response = jobServiceClient.getDataLabelingJob(request);
}
Name | Description |
request | GetDataLabelingJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
DataLabelingJob |
getDataLabelingJob(String name)
public final DataLabelingJob getDataLabelingJob(String name)
Gets a DataLabelingJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
DataLabelingJobName.of("[PROJECT]", "[LOCATION]", "[DATA_LABELING_JOB]").toString();
DataLabelingJob response = jobServiceClient.getDataLabelingJob(name);
}
Name | Description |
name | String Required. The name of the DataLabelingJob. Format:
|
Type | Description |
DataLabelingJob |
getDataLabelingJobCallable()
public final UnaryCallable<GetDataLabelingJobRequest,DataLabelingJob> getDataLabelingJobCallable()
Gets a DataLabelingJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetDataLabelingJobRequest,DataLabelingJob> |
getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)
public final HyperparameterTuningJob getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)
Gets a HyperparameterTuningJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
GetHyperparameterTuningJobRequest request =
GetHyperparameterTuningJobRequest.newBuilder()
.setName(
HyperparameterTuningJobName.of(
"[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
.toString())
.build();
HyperparameterTuningJob response = jobServiceClient.getHyperparameterTuningJob(request);
}
Name | Description |
request | GetHyperparameterTuningJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
HyperparameterTuningJob |
getHyperparameterTuningJob(HyperparameterTuningJobName name)
public final HyperparameterTuningJob getHyperparameterTuningJob(HyperparameterTuningJobName name)
Gets a HyperparameterTuningJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
HyperparameterTuningJobName name =
HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]");
HyperparameterTuningJob response = jobServiceClient.getHyperparameterTuningJob(name);
}
Name | Description |
name | HyperparameterTuningJobName Required. The name of the HyperparameterTuningJob resource. Format:
|
Type | Description |
HyperparameterTuningJob |
getHyperparameterTuningJob(String name)
public final HyperparameterTuningJob getHyperparameterTuningJob(String name)
Gets a HyperparameterTuningJob
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
HyperparameterTuningJobName.of("[PROJECT]", "[LOCATION]", "[HYPERPARAMETER_TUNING_JOB]")
.toString();
HyperparameterTuningJob response = jobServiceClient.getHyperparameterTuningJob(name);
}
Name | Description |
name | String Required. The name of the HyperparameterTuningJob resource. Format:
|
Type | Description |
HyperparameterTuningJob |
getHyperparameterTuningJobCallable()
public final UnaryCallable<GetHyperparameterTuningJobRequest,HyperparameterTuningJob> getHyperparameterTuningJobCallable()
Gets a HyperparameterTuningJob
Sample code:
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();
}
Type | Description |
UnaryCallable<GetHyperparameterTuningJobRequest,HyperparameterTuningJob> |
getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)
public final ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)
Gets a ModelDeploymentMonitoringJob.
Sample code:
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);
}
Name | Description |
request | GetModelDeploymentMonitoringJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
ModelDeploymentMonitoringJob |
getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)
public final ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(ModelDeploymentMonitoringJobName name)
Gets a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
ModelDeploymentMonitoringJobName name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
ModelDeploymentMonitoringJob response =
jobServiceClient.getModelDeploymentMonitoringJob(name);
}
Name | Description |
name | ModelDeploymentMonitoringJobName Required. The resource name of the ModelDeploymentMonitoringJob. Format:
|
Type | Description |
ModelDeploymentMonitoringJob |
getModelDeploymentMonitoringJob(String name)
public final ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(String name)
Gets a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString();
ModelDeploymentMonitoringJob response =
jobServiceClient.getModelDeploymentMonitoringJob(name);
}
Name | Description |
name | String Required. The resource name of the ModelDeploymentMonitoringJob. Format:
|
Type | Description |
ModelDeploymentMonitoringJob |
getModelDeploymentMonitoringJobCallable()
public final UnaryCallable<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJobCallable()
Gets a ModelDeploymentMonitoringJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> |
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.
Type | Description |
OperationsClient |
getSettings()
public final JobServiceSettings getSettings()
Type | Description |
JobServiceSettings |
getStub()
public JobServiceStub getStub()
Type | Description |
JobServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listBatchPredictionJobs(ListBatchPredictionJobsRequest request)
public final JobServiceClient.ListBatchPredictionJobsPagedResponse listBatchPredictionJobs(ListBatchPredictionJobsRequest request)
Lists BatchPredictionJobs in a Location.
Sample code:
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);
}
}
Name | Description |
request | ListBatchPredictionJobsRequest The request object containing all of the parameters for the API call. |
Type | Description |
JobServiceClient.ListBatchPredictionJobsPagedResponse |
listBatchPredictionJobs(LocationName parent)
public final JobServiceClient.ListBatchPredictionJobsPagedResponse listBatchPredictionJobs(LocationName parent)
Lists BatchPredictionJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (BatchPredictionJob element :
jobServiceClient.listBatchPredictionJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The resource name of the Location to list the BatchPredictionJobs from.
Format: |
Type | Description |
JobServiceClient.ListBatchPredictionJobsPagedResponse |
listBatchPredictionJobs(String parent)
public final JobServiceClient.ListBatchPredictionJobsPagedResponse listBatchPredictionJobs(String parent)
Lists BatchPredictionJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (BatchPredictionJob element :
jobServiceClient.listBatchPredictionJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the Location to list the BatchPredictionJobs from.
Format: |
Type | Description |
JobServiceClient.ListBatchPredictionJobsPagedResponse |
listBatchPredictionJobsCallable()
public final UnaryCallable<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse> listBatchPredictionJobsCallable()
Lists BatchPredictionJobs in a Location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse> |
listBatchPredictionJobsPagedCallable()
public final UnaryCallable<ListBatchPredictionJobsRequest,JobServiceClient.ListBatchPredictionJobsPagedResponse> listBatchPredictionJobsPagedCallable()
Lists BatchPredictionJobs in a Location.
Sample code:
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);
}
}
Type | Description |
UnaryCallable<ListBatchPredictionJobsRequest,ListBatchPredictionJobsPagedResponse> |
listCustomJobs(ListCustomJobsRequest request)
public final JobServiceClient.ListCustomJobsPagedResponse listCustomJobs(ListCustomJobsRequest request)
Lists CustomJobs in a Location.
Sample code:
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);
}
}
Name | Description |
request | ListCustomJobsRequest The request object containing all of the parameters for the API call. |
Type | Description |
JobServiceClient.ListCustomJobsPagedResponse |
listCustomJobs(LocationName parent)
public final JobServiceClient.ListCustomJobsPagedResponse listCustomJobs(LocationName parent)
Lists CustomJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (CustomJob element : jobServiceClient.listCustomJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The resource name of the Location to list the CustomJobs from. Format:
|
Type | Description |
JobServiceClient.ListCustomJobsPagedResponse |
listCustomJobs(String parent)
public final JobServiceClient.ListCustomJobsPagedResponse listCustomJobs(String parent)
Lists CustomJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (CustomJob element : jobServiceClient.listCustomJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the Location to list the CustomJobs from. Format:
|
Type | Description |
JobServiceClient.ListCustomJobsPagedResponse |
listCustomJobsCallable()
public final UnaryCallable<ListCustomJobsRequest,ListCustomJobsResponse> listCustomJobsCallable()
Lists CustomJobs in a Location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListCustomJobsRequest,ListCustomJobsResponse> |
listCustomJobsPagedCallable()
public final UnaryCallable<ListCustomJobsRequest,JobServiceClient.ListCustomJobsPagedResponse> listCustomJobsPagedCallable()
Lists CustomJobs in a Location.
Sample code:
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);
}
}
Type | Description |
UnaryCallable<ListCustomJobsRequest,ListCustomJobsPagedResponse> |
listDataLabelingJobs(ListDataLabelingJobsRequest request)
public final JobServiceClient.ListDataLabelingJobsPagedResponse listDataLabelingJobs(ListDataLabelingJobsRequest request)
Lists DataLabelingJobs in a Location.
Sample code:
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);
}
}
Name | Description |
request | ListDataLabelingJobsRequest The request object containing all of the parameters for the API call. |
Type | Description |
JobServiceClient.ListDataLabelingJobsPagedResponse |
listDataLabelingJobs(LocationName parent)
public final JobServiceClient.ListDataLabelingJobsPagedResponse listDataLabelingJobs(LocationName parent)
Lists DataLabelingJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (DataLabelingJob element : jobServiceClient.listDataLabelingJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The parent of the DataLabelingJob. Format:
|
Type | Description |
JobServiceClient.ListDataLabelingJobsPagedResponse |
listDataLabelingJobs(String parent)
public final JobServiceClient.ListDataLabelingJobsPagedResponse listDataLabelingJobs(String parent)
Lists DataLabelingJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (DataLabelingJob element : jobServiceClient.listDataLabelingJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The parent of the DataLabelingJob. Format:
|
Type | Description |
JobServiceClient.ListDataLabelingJobsPagedResponse |
listDataLabelingJobsCallable()
public final UnaryCallable<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse> listDataLabelingJobsCallable()
Lists DataLabelingJobs in a Location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse> |
listDataLabelingJobsPagedCallable()
public final UnaryCallable<ListDataLabelingJobsRequest,JobServiceClient.ListDataLabelingJobsPagedResponse> listDataLabelingJobsPagedCallable()
Lists DataLabelingJobs in a Location.
Sample code:
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);
}
}
Type | Description |
UnaryCallable<ListDataLabelingJobsRequest,ListDataLabelingJobsPagedResponse> |
listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)
public final JobServiceClient.ListHyperparameterTuningJobsPagedResponse listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)
Lists HyperparameterTuningJobs in a Location.
Sample code:
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);
}
}
Name | Description |
request | ListHyperparameterTuningJobsRequest The request object containing all of the parameters for the API call. |
Type | Description |
JobServiceClient.ListHyperparameterTuningJobsPagedResponse |
listHyperparameterTuningJobs(LocationName parent)
public final JobServiceClient.ListHyperparameterTuningJobsPagedResponse listHyperparameterTuningJobs(LocationName parent)
Lists HyperparameterTuningJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (HyperparameterTuningJob element :
jobServiceClient.listHyperparameterTuningJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The resource name of the Location to list the HyperparameterTuningJobs
from. Format: |
Type | Description |
JobServiceClient.ListHyperparameterTuningJobsPagedResponse |
listHyperparameterTuningJobs(String parent)
public final JobServiceClient.ListHyperparameterTuningJobsPagedResponse listHyperparameterTuningJobs(String parent)
Lists HyperparameterTuningJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (HyperparameterTuningJob element :
jobServiceClient.listHyperparameterTuningJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the Location to list the HyperparameterTuningJobs
from. Format: |
Type | Description |
JobServiceClient.ListHyperparameterTuningJobsPagedResponse |
listHyperparameterTuningJobsCallable()
public final UnaryCallable<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse> listHyperparameterTuningJobsCallable()
Lists HyperparameterTuningJobs in a Location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse> |
listHyperparameterTuningJobsPagedCallable()
public final UnaryCallable<ListHyperparameterTuningJobsRequest,JobServiceClient.ListHyperparameterTuningJobsPagedResponse> listHyperparameterTuningJobsPagedCallable()
Lists HyperparameterTuningJobs in a Location.
Sample code:
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);
}
}
Type | Description |
UnaryCallable<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsPagedResponse> |
listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)
public final JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)
Lists ModelDeploymentMonitoringJobs in a Location.
Sample code:
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);
}
}
Name | Description |
request | ListModelDeploymentMonitoringJobsRequest The request object containing all of the parameters for the API call. |
Type | Description |
JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse |
listModelDeploymentMonitoringJobs(LocationName parent)
public final JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse listModelDeploymentMonitoringJobs(LocationName parent)
Lists ModelDeploymentMonitoringJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (ModelDeploymentMonitoringJob element :
jobServiceClient.listModelDeploymentMonitoringJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The parent of the ModelDeploymentMonitoringJob. Format:
|
Type | Description |
JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse |
listModelDeploymentMonitoringJobs(String parent)
public final JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse listModelDeploymentMonitoringJobs(String parent)
Lists ModelDeploymentMonitoringJobs in a Location.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (ModelDeploymentMonitoringJob element :
jobServiceClient.listModelDeploymentMonitoringJobs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The parent of the ModelDeploymentMonitoringJob. Format:
|
Type | Description |
JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse |
listModelDeploymentMonitoringJobsCallable()
public final UnaryCallable<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse> listModelDeploymentMonitoringJobsCallable()
Lists ModelDeploymentMonitoringJobs in a Location.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse> |
listModelDeploymentMonitoringJobsPagedCallable()
public final UnaryCallable<ListModelDeploymentMonitoringJobsRequest,JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse> listModelDeploymentMonitoringJobsPagedCallable()
Lists ModelDeploymentMonitoringJobs in a Location.
Sample code:
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);
}
}
Type | Description |
UnaryCallable<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsPagedResponse> |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
ModelDeploymentMonitoringJobName name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
jobServiceClient.pauseModelDeploymentMonitoringJob(name);
}
Name | Description |
name | ModelDeploymentMonitoringJobName Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format:
|
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
PauseModelDeploymentMonitoringJobRequest request =
PauseModelDeploymentMonitoringJobRequest.newBuilder()
.setName(
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString())
.build();
jobServiceClient.pauseModelDeploymentMonitoringJob(request);
}
Name | Description |
request | PauseModelDeploymentMonitoringJobRequest 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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString();
jobServiceClient.pauseModelDeploymentMonitoringJob(name);
}
Name | Description |
name | String Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format:
|
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:
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();
}
Type | Description |
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
ModelDeploymentMonitoringJobName name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]");
jobServiceClient.resumeModelDeploymentMonitoringJob(name);
}
Name | Description |
name | ModelDeploymentMonitoringJobName Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format:
|
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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
ResumeModelDeploymentMonitoringJobRequest request =
ResumeModelDeploymentMonitoringJobRequest.newBuilder()
.setName(
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString())
.build();
jobServiceClient.resumeModelDeploymentMonitoringJob(request);
}
Name | Description |
request | ResumeModelDeploymentMonitoringJobRequest 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:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
String name =
ModelDeploymentMonitoringJobName.of(
"[PROJECT]", "[LOCATION]", "[MODEL_DEPLOYMENT_MONITORING_JOB]")
.toString();
jobServiceClient.resumeModelDeploymentMonitoringJob(name);
}
Name | Description |
name | String Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format:
|
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:
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();
}
Type | Description |
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:
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);
}
}
Name | Description |
modelDeploymentMonitoringJob | ModelDeploymentMonitoringJobName Required. ModelDeploymentMonitoring Job resource name.
Format:
|
deployedModelId | String Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. |
Type | Description |
JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse |
searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)
public final JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)
Searches Model Monitoring Statistics generated within a given time window.
Sample code:
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);
}
}
Name | Description |
request | SearchModelDeploymentMonitoringStatsAnomaliesRequest The request object containing all of the parameters for the API call. |
Type | Description |
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:
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);
}
}
Name | Description |
modelDeploymentMonitoringJob | String Required. ModelDeploymentMonitoring Job resource name.
Format:
|
deployedModelId | String Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. |
Type | Description |
JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse |
searchModelDeploymentMonitoringStatsAnomaliesCallable()
public final UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse> searchModelDeploymentMonitoringStatsAnomaliesCallable()
Searches Model Monitoring Statistics generated within a given time window.
Sample code:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse> |
searchModelDeploymentMonitoringStatsAnomaliesPagedCallable()
public final UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse> searchModelDeploymentMonitoringStatsAnomaliesPagedCallable()
Searches Model Monitoring Statistics generated within a given time window.
Sample code:
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);
}
}
Type | Description |
UnaryCallable<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, FieldMask updateMask)
public final OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobAsync(ModelDeploymentMonitoringJob modelDeploymentMonitoringJob, FieldMask updateMask)
Updates a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
ModelDeploymentMonitoringJob modelDeploymentMonitoringJob =
ModelDeploymentMonitoringJob.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ModelDeploymentMonitoringJob response =
jobServiceClient
.updateModelDeploymentMonitoringJobAsync(modelDeploymentMonitoringJob, updateMask)
.get();
}
Name | Description |
modelDeploymentMonitoringJob | ModelDeploymentMonitoringJob Required. The model monitoring configuration which replaces the resource on the server. |
updateMask | FieldMask 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 Updatable fields: * |
Type | Description |
OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> |
updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request)
public final OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobAsync(UpdateModelDeploymentMonitoringJobRequest request)
Updates a ModelDeploymentMonitoringJob.
Sample code:
try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
UpdateModelDeploymentMonitoringJobRequest request =
UpdateModelDeploymentMonitoringJobRequest.newBuilder()
.setModelDeploymentMonitoringJob(ModelDeploymentMonitoringJob.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ModelDeploymentMonitoringJob response =
jobServiceClient.updateModelDeploymentMonitoringJobAsync(request).get();
}
Name | Description |
request | UpdateModelDeploymentMonitoringJobRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> |
updateModelDeploymentMonitoringJobCallable()
public final UnaryCallable<UpdateModelDeploymentMonitoringJobRequest,Operation> updateModelDeploymentMonitoringJobCallable()
Updates a ModelDeploymentMonitoringJob.
Sample code:
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();
}
Type | Description |
UnaryCallable<UpdateModelDeploymentMonitoringJobRequest,Operation> |
updateModelDeploymentMonitoringJobOperationCallable()
public final OperationCallable<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobOperationCallable()
Updates a ModelDeploymentMonitoringJob.
Sample code:
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();
}
Type | Description |
OperationCallable<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> |