// Code generated by sidekick. DO NOT EDIT.
//
// Copyright 2026 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
//
//     https://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.

#if PipelineService || ScheduleService
  import Foundation

  /// Describes the state of a pipeline.
  public enum PipelineState: Codable, Equatable, Sendable {
    /// The pipeline state is unspecified.
    case unspecified
    /// The pipeline has been created or resumed, and processing has not yet
    /// begun.
    case queued
    /// The service is preparing to run the pipeline.
    case pending
    /// The pipeline is in progress.
    case running
    /// The pipeline completed successfully.
    case succeeded
    /// The pipeline failed.
    case failed
    /// The pipeline is being cancelled. From this state, the pipeline may only go
    /// to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or
    /// PIPELINE_STATE_CANCELLED.
    case cancelling
    /// The pipeline has been cancelled.
    case cancelled
    /// The pipeline has been stopped, and can be resumed.
    case paused
    /// Encodes an unknown integer value.
    ///
    /// The most common cause for an unknown values is for the service to send
    /// a value unknown to the library. We recommend you update your library to
    /// the latest version.
    case unknownIntValue(Int)
    /// Encodes an unknown string value.
    ///
    /// The most common cause for an unknown values is for the service to send
    /// a value unknown to the library. We recommend you update your library to
    /// the latest version.
    case unknownStringValue(String)

    public init() {
      self = .unspecified
    }

    /// Returns the integer value associated with the enumeration.
    ///
    /// If the enumeration was initialized with an unknown string value, this returns `nil`.
    public var intValue: Int? {
      switch self {
      case .unspecified: return 0
      case .queued: return 1
      case .pending: return 2
      case .running: return 3
      case .succeeded: return 4
      case .failed: return 5
      case .cancelling: return 6
      case .cancelled: return 7
      case .paused: return 8
      case .unknownIntValue(let v): return v
      case .unknownStringValue: return nil
      }
    }

    /// Returns the string value (or name) associated with the enumeration.
    ///
    /// If the enumeration was initialized with an unknown integer value, this returns `nil`.
    public var stringValue: Swift.String? {
      switch self {
      case .unspecified: return "PIPELINE_STATE_UNSPECIFIED"
      case .queued: return "PIPELINE_STATE_QUEUED"
      case .pending: return "PIPELINE_STATE_PENDING"
      case .running: return "PIPELINE_STATE_RUNNING"
      case .succeeded: return "PIPELINE_STATE_SUCCEEDED"
      case .failed: return "PIPELINE_STATE_FAILED"
      case .cancelling: return "PIPELINE_STATE_CANCELLING"
      case .cancelled: return "PIPELINE_STATE_CANCELLED"
      case .paused: return "PIPELINE_STATE_PAUSED"
      case .unknownIntValue: return nil
      case .unknownStringValue(let v): return v
      }
    }

    /// Initialize from a string value.
    ///
    /// If the value is unknown, this initializes to [`unknownStringValue`](doc:PipelineState/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "PIPELINE_STATE_UNSPECIFIED": self = .unspecified
      case "PIPELINE_STATE_QUEUED": self = .queued
      case "PIPELINE_STATE_PENDING": self = .pending
      case "PIPELINE_STATE_RUNNING": self = .running
      case "PIPELINE_STATE_SUCCEEDED": self = .succeeded
      case "PIPELINE_STATE_FAILED": self = .failed
      case "PIPELINE_STATE_CANCELLING": self = .cancelling
      case "PIPELINE_STATE_CANCELLED": self = .cancelled
      case "PIPELINE_STATE_PAUSED": self = .paused
      default: self = .unknownStringValue(stringValue)
      }
    }

    /// Initialize from an integer value.
    ///
    /// If the value is unknown, this initializes to [`unknownIntValue`](doc:PipelineState/unknownIntValue(_:)).
    public init(intValue: Int) {
      switch intValue {
      case 0: self = .unspecified
      case 1: self = .queued
      case 2: self = .pending
      case 3: self = .running
      case 4: self = .succeeded
      case 5: self = .failed
      case 6: self = .cancelling
      case 7: self = .cancelled
      case 8: self = .paused
      default: self = .unknownIntValue(intValue)
      }
    }

    public init(from decoder: Decoder) throws {
      let container = try decoder.singleValueContainer()
      if let v = try? container.decode(Int.self) {
        self.init(intValue: v)
        return
      }
      if let s = try? container.decode(String.self) {
        if let v = Int(s) {
          self.init(intValue: v)
        } else {
          self.init(stringValue: s)
        }
        return
      }
      throw DecodingError.dataCorruptedError(
        in: container, debugDescription: "Expected enum value, must be integer or string.")
    }

    public func encode(to encoder: Encoder) throws {
      var container = encoder.singleValueContainer()
      switch self {
      case .unspecified: return try container.encode(0)
      case .queued: return try container.encode(1)
      case .pending: return try container.encode(2)
      case .running: return try container.encode(3)
      case .succeeded: return try container.encode(4)
      case .failed: return try container.encode(5)
      case .cancelling: return try container.encode(6)
      case .cancelled: return try container.encode(7)
      case .paused: return try container.encode(8)
      case .unknownIntValue(let v): return try container.encode(v)
      case .unknownStringValue(let v): return try container.encode(v)
      }
    }
  }
#endif
