1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.aiplatform.v1;
18
19option csharp_namespace = "Google.Cloud.AIPlatform.V1";
20option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
21option java_multiple_files = true;
22option java_outer_classname = "JobStateProto";
23option java_package = "com.google.cloud.aiplatform.v1";
24option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
25option ruby_package = "Google::Cloud::AIPlatform::V1";
26
27// Describes the state of a job.
28enum JobState {
29  // The job state is unspecified.
30  JOB_STATE_UNSPECIFIED = 0;
31
32  // The job has been just created or resumed and processing has not yet begun.
33  JOB_STATE_QUEUED = 1;
34
35  // The service is preparing to run the job.
36  JOB_STATE_PENDING = 2;
37
38  // The job is in progress.
39  JOB_STATE_RUNNING = 3;
40
41  // The job completed successfully.
42  JOB_STATE_SUCCEEDED = 4;
43
44  // The job failed.
45  JOB_STATE_FAILED = 5;
46
47  // The job is being cancelled. From this state the job may only go to
48  // either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
49  JOB_STATE_CANCELLING = 6;
50
51  // The job has been cancelled.
52  JOB_STATE_CANCELLED = 7;
53
54  // The job has been stopped, and can be resumed.
55  JOB_STATE_PAUSED = 8;
56
57  // The job has expired.
58  JOB_STATE_EXPIRED = 9;
59
60  // The job is being updated. Only jobs in the `RUNNING` state can be updated.
61  // After updating, the job goes back to the `RUNNING` state.
62  JOB_STATE_UPDATING = 10;
63}
64