// 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 Rule resource represents a user-created rule.
/// NEXT TAG: 21
public struct Rule: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Identifier. Full resource name for the rule.
  /// Format:
  /// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
  public var name: Swift.String = Swift.String()

  /// Output only. The revision ID of the rule.
  /// A new revision is created whenever the rule text is changed in any way.
  /// Format: `v_{10 digits}_{9 digits}`
  /// Populated in REVISION_METADATA_ONLY view and FULL view.
  public var revisionId: Swift.String = Swift.String()

  /// Output only. Display name of the rule.
  /// Populated in BASIC view and FULL view.
  public var displayName: Swift.String = Swift.String()

  /// The YARA-L content of the rule.
  /// Populated in FULL view.
  public var text: Swift.String = Swift.String()

  /// Output only. The author of the rule. Extracted from the meta section of
  /// text. Populated in BASIC view and FULL view.
  public var author: Swift.String = Swift.String()

  /// Output only. The severity of the rule as specified in the meta section of
  /// text. Populated in BASIC view and FULL view.
  public var severity: Severity? = nil

  /// Output only. Additional metadata specified in the meta section of text.
  /// Populated in FULL view.
  public var metadata: [Swift.String: Swift.String] = [:]

  /// Output only. The timestamp of when the rule was created.
  /// Populated in FULL view.
  public var createTime: GoogleCloudWkt.Timestamp? = nil

  /// Output only. The timestamp of when the rule revision was created.
  /// Populated in FULL, REVISION_METADATA_ONLY views.
  public var revisionCreateTime: GoogleCloudWkt.Timestamp? = nil

  /// Output only. The current compilation state of the rule.
  /// Populated in FULL view.
  public var compilationState: Rule.CompilationState = Rule.CompilationState()

  /// Output only. User-facing type of the rule. Extracted from the events
  /// section of rule text. Populated in BASIC view and FULL view.
  public var type: RuleType = RuleType()

  /// Output only. Resource names of the reference lists used in this rule.
  /// Populated in FULL view.
  public var referenceLists: [Swift.String] = []

  /// Output only. The run frequencies that are allowed for the rule.
  /// Populated in BASIC view and FULL view.
  public var allowedRunFrequencies: [RunFrequency] = []

  /// The etag for this rule.
  /// If this is provided on update, the request will succeed if and only if it
  /// matches the server-computed value, and will fail with an ABORTED error
  /// otherwise.
  /// Populated in BASIC view and FULL view.
  public var etag: Swift.String = Swift.String()

  /// Resource name of the DataAccessScope bound to this rule.
  /// Populated in BASIC view and FULL view.
  /// If reference lists are used in the rule, validations will be performed
  /// against this scope to ensure that the reference lists are compatible with
  /// both the user's and the rule's scopes.
  /// The scope should be in the format:
  /// `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope}`.
  public var scope: Swift.String = Swift.String()

  /// Output only. A list of a rule's corresponding compilation diagnostic
  /// messages such as compilation errors and compilation warnings. Populated in
  /// FULL view.
  public var compilationDiagnostics: [CompilationDiagnostic] = []

  /// Output only. Indicate the rule can run in near real time live rule.
  /// If this is true, the rule uses the near real time live rule when the run
  /// frequency is set to LIVE.
  public var nearRealTimeLiveRuleEligible: Swift.Bool = Swift.Bool()

  /// Output only. The set of inputs used in the rule. For example, if the rule
  /// uses $e.principal.hostname, then the uses_udm field will be true.
  public var inputsUsed: InputsUsed? = nil

  /// Initialize a new instance of `Rule`.
  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 = Rule().with { $0.name = ... }
  /// ```
  public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
    var copy = self
    try config(&copy)
    return copy
  }

  /// The current compilation state of the rule.
  public enum CompilationState: Codable, Equatable, Sendable {
    /// The compilation state is unspecified/unknown.
    case unspecified
    /// The Rule can successfully compile.
    case succeeded
    /// The Rule cannot successfully compile.
    /// This is possible if a backwards-incompatible change was made to the
    /// compiler.
    case failed
    /// 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 .succeeded: return 1
      case .failed: return 2
      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 "COMPILATION_STATE_UNSPECIFIED"
      case .succeeded: return "SUCCEEDED"
      case .failed: return "FAILED"
      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:CompilationState/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "COMPILATION_STATE_UNSPECIFIED": self = .unspecified
      case "SUCCEEDED": self = .succeeded
      case "FAILED": self = .failed
      default: self = .unknownStringValue(stringValue)
      }
    }

    /// Initialize from an integer value.
    ///
    /// If the value is unknown, this initializes to [`unknownIntValue`](doc:CompilationState/unknownIntValue(_:)).
    public init(intValue: Int) {
      switch intValue {
      case 0: self = .unspecified
      case 1: self = .succeeded
      case 2: self = .failed
      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 .succeeded: return try container.encode(1)
      case .failed: return try container.encode(2)
      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.Rule"
  }
  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)
  }
}
