private/google/cloud/aiplatform/v1beta1/job_service.proto
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/batch_prediction_job.proto";
import "google/cloud/aiplatform/v1beta1/custom_job.proto";
import "google/cloud/aiplatform/v1beta1/data_labeling_job.proto";
import "google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "JobServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
// A service for creating and managing AI Platform's jobs.
service JobService {
option (google.api.default_host) = "aiplatform.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
// Creates a CustomJob. A created CustomJob right away
// will be attempted to be run.
rpc CreateCustomJob(CreateCustomJobRequest) returns (CustomJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/customJobs"
body: "custom_job"
};
option (google.api.method_signature) = "parent,custom_job";
}
// Gets a CustomJob.
rpc GetCustomJob(GetCustomJobRequest) returns (CustomJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/customJobs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists CustomJobs in a Location.
rpc ListCustomJobs(ListCustomJobsRequest) returns (ListCustomJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/customJobs"
};
option (google.api.method_signature) = "parent";
}
// Deletes a CustomJob.
rpc DeleteCustomJob(DeleteCustomJobRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/customJobs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Cancels a CustomJob.
// Starts asynchronous cancellation on the CustomJob. The server
// makes a best effort to cancel the job, but success is not
// guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob] or
// other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the CustomJob is not deleted; instead it becomes a job with
// a [CustomJob.error][google.cloud.aiplatform.v1beta1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set to
// `CANCELLED`.
rpc CancelCustomJob(CancelCustomJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/customJobs/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Creates a DataLabelingJob.
rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) returns (DataLabelingJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/dataLabelingJobs"
body: "data_labeling_job"
};
option (google.api.method_signature) = "parent,data_labeling_job";
}
// Gets a DataLabelingJob.
rpc GetDataLabelingJob(GetDataLabelingJobRequest) returns (DataLabelingJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists DataLabelingJobs in a Location.
rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) returns (ListDataLabelingJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/dataLabelingJobs"
};
option (google.api.method_signature) = "parent";
}
// Deletes a DataLabelingJob.
rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Creates a HyperparameterTuningJob
rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/hyperparameterTuningJobs"
body: "hyperparameter_tuning_job"
};
option (google.api.method_signature) = "parent,hyperparameter_tuning_job";
}
// Gets a HyperparameterTuningJob
rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists HyperparameterTuningJobs in a Location.
rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) returns (ListHyperparameterTuningJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/hyperparameterTuningJobs"
};
option (google.api.method_signature) = "parent";
}
// Deletes a HyperparameterTuningJob.
rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Cancels a HyperparameterTuningJob.
// Starts asynchronous cancellation on the HyperparameterTuningJob. The server
// makes a best effort to cancel the job, but success is not
// guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob] or
// other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the HyperparameterTuningJob is not deleted; instead it becomes a job with
// a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code]
// of 1, corresponding to `Code.CANCELLED`, and
// [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state] is set to `CANCELLED`.
rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Creates a BatchPredictionJob. A BatchPredictionJob once created will
// right away be attempted to start.
rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) returns (BatchPredictionJob) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/batchPredictionJobs"
body: "batch_prediction_job"
};
option (google.api.method_signature) = "parent,batch_prediction_job";
}
// Gets a BatchPredictionJob
rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) returns (BatchPredictionJob) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists BatchPredictionJobs in a Location.
rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) returns (ListBatchPredictionJobsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/batchPredictionJobs"
};
option (google.api.method_signature) = "parent";
}
// Deletes a BatchPredictionJob. Can only be called on jobs that already
// finished.
rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Cancels a BatchPredictionJob.
//
// Starts asynchronous cancellation on the BatchPredictionJob. The server
// makes the best effort to cancel the job, but success is not
// guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob] or
// other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On a successful cancellation,
// the BatchPredictionJob is not deleted;instead its
// [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already
// outputted by the job are not deleted.
rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}
}
// Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob].
message CreateCustomJobRequest {
// Required. The resource name of the Location to create the CustomJob in.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. The CustomJob to create.
CustomJob custom_job = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob].
message GetCustomJobRequest {
// Required. The name of the CustomJob resource.
// Format:
// `projects/{project}/locations/{location}/customJobs/{custom_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/CustomJob"
}
];
}
// Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs].
message ListCustomJobsRequest {
// Required. The resource name of the Location to list the CustomJobs from.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The standard list filter.
//
// Supported fields:
//
// * `display_name` supports = and !=.
//
// * `state` supports = and !=.
//
// Some examples of using the filter are:
//
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
//
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
//
// * `NOT display_name="my_job"`
//
// * `state="JOB_STATE_FAILED"`
string filter = 2;
// The standard list page size.
int32 page_size = 3;
// The standard list page token.
// Typically obtained via
// [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token] of the previous
// [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs] call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
// Response message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs]
message ListCustomJobsResponse {
// List of CustomJobs in the requested page.
repeated CustomJob custom_jobs = 1;
// A token to retrieve next page of results.
// Pass to [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsRequest.page_token] to obtain that page.
string next_page_token = 2;
}
// Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob].
message DeleteCustomJobRequest {
// Required. The name of the CustomJob resource to be deleted.
// Format:
// `projects/{project}/locations/{location}/customJobs/{custom_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/CustomJob"
}
];
}
// Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob].
message CancelCustomJobRequest {
// Required. The name of the CustomJob to cancel.
// Format:
// `projects/{project}/locations/{location}/customJobs/{custom_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/CustomJob"
}
];
}
// Request message for [DataLabelingJobService.CreateDataLabelingJob][].
message CreateDataLabelingJobRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. The DataLabelingJob to create.
DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [DataLabelingJobService.GetDataLabelingJob][].
message GetDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
//
// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/DataLabelingJob"
}
];
}
// Request message for [DataLabelingJobService.ListDataLabelingJobs][].
message ListDataLabelingJobsRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The standard list filter.
//
// Supported fields:
//
// * `display_name` supports = and !=.
//
// * `state` supports = and !=.
//
// Some examples of using the filter are:
//
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
//
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
//
// * `NOT display_name="my_job"`
//
// * `state="JOB_STATE_FAILED"`
string filter = 2;
// The standard list page size.
int32 page_size = 3;
// The standard list page token.
string page_token = 4;
// Mask specifying which fields to read. FieldMask represents a set of
// symbolic field paths. For example, the mask can be `paths: "name"`. The
// "name" here is a field in DataLabelingJob.
// If this field is not set, all fields of the DataLabelingJob are returned.
google.protobuf.FieldMask read_mask = 5;
// A comma-separated list of fields to order by, sorted in ascending order by
// default.
// Use `desc` after a field name for descending.
string order_by = 6;
}
// Response message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs].
message ListDataLabelingJobsResponse {
// A list of DataLabelingJobs that matches the specified filter in the
// request.
repeated DataLabelingJob data_labeling_jobs = 1;
// The standard List next-page token.
string next_page_token = 2;
}
// Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob].
message DeleteDataLabelingJobRequest {
// Required. The name of the DataLabelingJob to be deleted.
// Format:
//
// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/DataLabelingJob"
}
];
}
// Request message for [DataLabelingJobService.CancelDataLabelingJob][].
message CancelDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
//
// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/DataLabelingJob"
}
];
}
// Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob].
message CreateHyperparameterTuningJobRequest {
// Required. The resource name of the Location to create the HyperparameterTuningJob in.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. The HyperparameterTuningJob to create.
HyperparameterTuningJob hyperparameter_tuning_job = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob].
message GetHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource.
// Format:
//
// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/HyperparameterTuningJob"
}
];
}
// Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs].
message ListHyperparameterTuningJobsRequest {
// Required. The resource name of the Location to list the HyperparameterTuningJobs
// from. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The standard list filter.
//
// Supported fields:
//
// * `display_name` supports = and !=.
//
// * `state` supports = and !=.
//
// Some examples of using the filter are:
//
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
//
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
//
// * `NOT display_name="my_job"`
//
// * `state="JOB_STATE_FAILED"`
string filter = 2;
// The standard list page size.
int32 page_size = 3;
// The standard list page token.
// Typically obtained via
// [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token] of the previous
// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs] call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
// Response message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]
message ListHyperparameterTuningJobsResponse {
// List of HyperparameterTuningJobs in the requested page.
// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials] of the jobs will be not be returned.
repeated HyperparameterTuningJob hyperparameter_tuning_jobs = 1;
// A token to retrieve next page of results.
// Pass to [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest.page_token] to obtain that
// page.
string next_page_token = 2;
}
// Request message for [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob].
message DeleteHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource to be deleted.
// Format:
//
// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/HyperparameterTuningJob"
}
];
}
// Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob].
message CancelHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob to cancel.
// Format:
//
// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/HyperparameterTuningJob"
}
];
}
// Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob].
message CreateBatchPredictionJobRequest {
// Required. The resource name of the Location to create the BatchPredictionJob in.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// Required. The BatchPredictionJob to create.
BatchPredictionJob batch_prediction_job = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob].
message GetBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource.
// Format:
//
// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/BatchPredictionJob"
}
];
}
// Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs].
message ListBatchPredictionJobsRequest {
// Required. The resource name of the Location to list the BatchPredictionJobs
// from. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The standard list filter.
//
// Supported fields:
//
// * `display_name` supports = and !=.
//
// * `state` supports = and !=.
//
// Some examples of using the filter are:
//
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
//
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
//
// * `NOT display_name="my_job"`
//
// * `state="JOB_STATE_FAILED"`
string filter = 2;
// The standard list page size.
int32 page_size = 3;
// The standard list page token.
// Typically obtained via
// [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token] of the previous
// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs] call.
string page_token = 4;
// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}
// Response message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs]
message ListBatchPredictionJobsResponse {
// List of BatchPredictionJobs in the requested page.
repeated BatchPredictionJob batch_prediction_jobs = 1;
// A token to retrieve next page of results.
// Pass to [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsRequest.page_token] to obtain that
// page.
string next_page_token = 2;
}
// Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob].
message DeleteBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource to be deleted.
// Format:
//
// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/BatchPredictionJob"
}
];
}
// Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob].
message CancelBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob to cancel.
// Format:
//
// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/BatchPredictionJob"
}
];
}