// 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.

import Foundation
import GoogleCloudWkt

/// The RuleDeployment resource represents the deployment state of a Rule.
public struct RuleDeployment: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. The resource name of the rule deployment.
  /// Note that RuleDeployment is a child of the overall Rule, not any individual
  /// revision, so the resource ID segment for the Rule resource must not
  /// reference a specific revision.
  /// Format:
  /// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment`
  public var name: Swift.String = Swift.String()

  /// Whether the rule is currently deployed continuously against incoming data.
  public var enabled: Swift.Bool = Swift.Bool()

  /// Whether detections resulting from this deployment should be considered
  /// alerts.
  public var alerting: Swift.Bool = Swift.Bool()

  /// The archive state of the rule deployment.
  /// Cannot be set to true unless enabled is set to false.
  /// If set to true, alerting will automatically be set to false.
  /// If currently set to true, enabled, alerting, and run_frequency cannot be
  /// updated.
  public var archived: Swift.Bool = Swift.Bool()

  /// Output only. The timestamp when the rule deployment archive state was last
  /// set to true. If the rule deployment's current archive state is not set to
  /// true, the field will be empty.
  public var archiveTime: GoogleCloudWkt.Timestamp? = nil

  /// The run frequency of the rule deployment.
  public var runFrequency: RunFrequency = RunFrequency()

  /// Output only. The execution state of the rule deployment.
  public var executionState: RuleDeployment.ExecutionState = RuleDeployment.ExecutionState()

  /// Output only. The names of the associated/chained producer rules. Rules are
  /// considered producers for this rule if this rule explicitly filters on their
  /// ruleid. Format:
  /// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
  public var producerRules: [Swift.String] = []

  /// Output only. The names of the associated/chained consumer rules. Rules are
  /// considered consumers of this rule if their rule text explicitly filters on
  /// this rule's ruleid. Format:
  /// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
  public var consumerRules: [Swift.String] = []

  /// Output only. The timestamp when the rule deployment alert state was lastly
  /// changed. This is filled regardless of the current alert state. E.g. if the
  /// current alert status is false, this timestamp will be the timestamp when
  /// the alert status was changed to false.
  public var lastAlertStatusChangeTime: GoogleCloudWkt.Timestamp? = nil

  /// Initialize a new instance of `RuleDeployment`.
  public init() {}

  /// Use `config` to return a new instance of this object, with some fields updated.
  ///
  /// Commonly used to initialize the value, for example:
  ///
  /// ```
  /// let value = RuleDeployment().with { $0.name = ... }
  /// ```
  public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
    var copy = self
    try config(&copy)
    return copy
  }

  /// The possible execution states the rule deployment can be in.
  public enum ExecutionState: Codable, Equatable, Sendable {
    /// Unspecified or unknown execution state.
    case unspecified
    /// Default execution state.
    case `default`
    /// Rules in limited state may not have their executions guaranteed.
    case limited
    /// Paused rules are not executed at all.
    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 .`default`: return 1
      case .limited: return 2
      case .paused: return 3
      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 "EXECUTION_STATE_UNSPECIFIED"
      case .`default`: return "DEFAULT"
      case .limited: return "LIMITED"
      case .paused: return "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:ExecutionState/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "EXECUTION_STATE_UNSPECIFIED": self = .unspecified
      case "DEFAULT": self = .`default`
      case "LIMITED": self = .limited
      case "PAUSED": self = .paused
      default: self = .unknownStringValue(stringValue)
      }
    }

    /// Initialize from an integer value.
    ///
    /// If the value is unknown, this initializes to [`unknownIntValue`](doc:ExecutionState/unknownIntValue(_:)).
    public init(intValue: Int) {
      switch intValue {
      case 0: self = .unspecified
      case 1: self = .`default`
      case 2: self = .limited
      case 3: 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 .`default`: return try container.encode(1)
      case .limited: return try container.encode(2)
      case .paused: return try container.encode(3)
      case .unknownIntValue(let v): return try container.encode(v)
      case .unknownStringValue(let v): return try container.encode(v)
      }
    }
  }

  public static var _anyTypeUrl: Swift.String {
    return "type.googleapis.com/google.cloud.chronicle.v1.RuleDeployment"
  }
  public init(fromAny any: GoogleCloudWkt.`Any`) throws {
    self = try GoogleCloudWkt._slowAnyDeserialize(Self.self, from: any)
  }
  public func _pack() throws -> GoogleCloudWkt.Struct {
    return try GoogleCloudWkt._slowAnySerialize(message: self)
  }
}
