// Copyright 2025 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.securitycenter.v2;

import "google/api/field_behavior.proto";

option csharp_namespace = "Google.Cloud.SecurityCenter.V2";
option go_package = "cloud.google.com/go/securitycenter/apiv2/securitycenterpb;securitycenterpb";
option java_multiple_files = true;
option java_outer_classname = "JobProto";
option java_package = "com.google.cloud.securitycenter.v2";
option php_namespace = "Google\\Cloud\\SecurityCenter\\V2";
option ruby_package = "Google::Cloud::SecurityCenter::V2";

// Describes a job
message Job {
  // The fully-qualified name for a job.
  // e.g. `projects/<project_id>/jobs/<job_id>`
  string name = 1;

  // Output only. State of the job, such as `RUNNING` or `PENDING`.
  JobState state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Optional. If the job did not complete successfully, this field describes
  // why.
  int32 error_code = 3;

  // Optional. Gives the location where the job ran, such as `US` or
  // `europe-west1`
  string location = 4;
}

// JobState represents the state of the job.
enum JobState {
  // Unspecified represents an unknown state and should not be used.
  JOB_STATE_UNSPECIFIED = 0;

  // Job is scheduled and pending for run
  PENDING = 1;

  // Job in progress
  RUNNING = 2;

  // Job has completed with success
  SUCCEEDED = 3;

  // Job has completed but with failure
  FAILED = 4;
}
