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

/// A `DeployPolicy` resource in the Cloud Deploy API.
///
/// A `DeployPolicy` inhibits manual or automation-driven actions within a
/// Delivery Pipeline or Target.
public struct DeployPolicy: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Output only. Name of the `DeployPolicy`. Format is
  /// `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
  /// The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
  public var name: Swift.String = Swift.String()

  /// Output only. Unique identifier of the `DeployPolicy`.
  public var uid: Swift.String = Swift.String()

  /// Optional. Description of the `DeployPolicy`. Max length is 255 characters.
  public var description: Swift.String = Swift.String()

  /// Optional. User annotations. These attributes can only be set and used by
  /// the user, and not by Cloud Deploy. Annotations must meet the following
  /// constraints:
  ///
  /// * Annotations are key/value pairs.
  /// * Valid annotation keys have two segments: an optional prefix and name,
  /// separated by a slash (`/`).
  /// * The name segment is required and must be 63 characters or less,
  /// beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with
  /// dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
  /// * The prefix is optional. If specified, the prefix must be a DNS subdomain:
  /// a series of DNS labels separated by dots(`.`), not longer than 253
  /// characters in total, followed by a slash (`/`).
  ///
  /// See
  /// https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
  /// for more details.
  public var annotations: [Swift.String: Swift.String] = [:]

  /// Labels are attributes that can be set and used by both the
  /// user and by Cloud Deploy. Labels must meet the following constraints:
  ///
  /// * Keys and values can contain only lowercase letters, numeric characters,
  /// underscores, and dashes.
  /// * All characters must use UTF-8 encoding, and international characters are
  /// allowed.
  /// * Keys must start with a lowercase letter or international character.
  /// * Each resource is limited to a maximum of 64 labels.
  ///
  /// Both keys and values are additionally constrained to be <= 128 bytes.
  public var labels: [Swift.String: Swift.String] = [:]

  /// Output only. Time at which the deploy policy was created.
  public var createTime: GoogleCloudWkt.Timestamp? = nil

  /// Output only. Most recent time at which the deploy policy was updated.
  public var updateTime: GoogleCloudWkt.Timestamp? = nil

  /// Optional. When suspended, the policy will not prevent actions from
  /// occurring, even if the action violates the policy.
  public var suspended: Swift.Bool = Swift.Bool()

  /// Required. Selected resources to which the policy will be applied. At least
  /// one selector is required. If one selector matches the resource the policy
  /// applies. For example, if there are two selectors and the action being
  /// attempted matches one of them, the policy will apply to that action.
  public var selectors: [DeployPolicyResourceSelector] = []

  /// Required. Rules to apply. At least one rule must be present.
  public var rules: [PolicyRule] = []

  /// The weak etag of the `DeployPolicy` resource.
  /// This checksum is computed by the server based on the value of other
  /// fields, and may be sent on update and delete requests to ensure the
  /// client has an up-to-date value before proceeding.
  public var etag: Swift.String = Swift.String()

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

  /// What invoked the action. Filters enforcing the policy depending on what
  /// invoked the action.
  public enum Invoker: Codable, Equatable, Sendable {
    /// Unspecified.
    case unspecified
    /// The action is user-driven. For example, creating a rollout manually via a
    /// gcloud create command.
    case user
    /// Automated action by Cloud Deploy.
    case deployAutomation
    /// 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 .user: return 1
      case .deployAutomation: 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 "INVOKER_UNSPECIFIED"
      case .user: return "USER"
      case .deployAutomation: return "DEPLOY_AUTOMATION"
      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:Invoker/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "INVOKER_UNSPECIFIED": self = .unspecified
      case "USER": self = .user
      case "DEPLOY_AUTOMATION": self = .deployAutomation
      default: self = .unknownStringValue(stringValue)
      }
    }

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