// Copyright 2024 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.v1;

option csharp_namespace = "Google.Cloud.AIPlatform.V1";
option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "JobStateProto";
option java_package = "com.google.cloud.aiplatform.v1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";

// Describes the state of a job.
enum JobState {
  // The job state is unspecified.
  JOB_STATE_UNSPECIFIED = 0;

  // The job has been just created or resumed and processing has not yet begun.
  JOB_STATE_QUEUED = 1;

  // The service is preparing to run the job.
  JOB_STATE_PENDING = 2;

  // The job is in progress.
  JOB_STATE_RUNNING = 3;

  // The job completed successfully.
  JOB_STATE_SUCCEEDED = 4;

  // The job failed.
  JOB_STATE_FAILED = 5;

  // The job is being cancelled. From this state the job may only go to
  // either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
  JOB_STATE_CANCELLING = 6;

  // The job has been cancelled.
  JOB_STATE_CANCELLED = 7;

  // The job has been stopped, and can be resumed.
  JOB_STATE_PAUSED = 8;

  // The job has expired.
  JOB_STATE_EXPIRED = 9;

  // The job is being updated. Only jobs in the `RUNNING` state can be updated.
  // After updating, the job goes back to the `RUNNING` state.
  JOB_STATE_UPDATING = 10;

  // The job is partially succeeded, some results may be missing due to errors.
  JOB_STATE_PARTIALLY_SUCCEEDED = 11;
}