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

/// Patch rollout configuration specifications. Contains details on the
/// concurrency control when applying patch(es) to all targeted VMs.
public struct PatchRollout: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Mode of the patch rollout.
  public var mode: PatchRollout.Mode = PatchRollout.Mode()

  /// The maximum number (or percentage) of VMs per zone to disrupt at any given
  /// moment. The number of VMs calculated from multiplying the percentage by the
  /// total number of VMs in a zone is rounded up.
  ///
  /// During patching, a VM is considered disrupted from the time the agent is
  /// notified to begin until patching has completed. This disruption time
  /// includes the time to complete reboot and any post-patch steps.
  ///
  /// A VM contributes to the disruption budget if its patching operation fails
  /// either when applying the patches, running pre or post patch steps, or if it
  /// fails to respond with a success notification before timing out. VMs that
  /// are not running or do not have an active agent do not count toward this
  /// disruption budget.
  ///
  /// For zone-by-zone rollouts, if the disruption budget in a zone is exceeded,
  /// the patch job stops, because continuing to the next zone requires
  /// completion of the patch process in the previous zone.
  ///
  /// For example, if the disruption budget has a fixed value of `10`, and 8 VMs
  /// fail to patch in the current zone, the patch job continues to patch 2 VMs
  /// at a time until the zone is completed. When that zone is completed
  /// successfully, patching begins with 10 VMs at a time in the next zone. If 10
  /// VMs in the next zone fail to patch, the patch job stops.
  public var disruptionBudget: FixedOrPercent? = nil

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

  /// Type of the rollout.
  public enum Mode: Codable, Equatable, Sendable {
    /// Mode must be specified.
    case unspecified
    /// Patches are applied one zone at a time. The patch job begins in the
    /// region with the lowest number of targeted VMs. Within the region,
    /// patching begins in the zone with the lowest number of targeted VMs. If
    /// multiple regions (or zones within a region) have the same number of
    /// targeted VMs, a tie-breaker is achieved by sorting the regions or zones
    /// in alphabetical order.
    case zoneByZone
    /// Patches are applied to VMs in all zones at the same time.
    case concurrentZones
    /// 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 .zoneByZone: return 1
      case .concurrentZones: 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 "MODE_UNSPECIFIED"
      case .zoneByZone: return "ZONE_BY_ZONE"
      case .concurrentZones: return "CONCURRENT_ZONES"
      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:Mode/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "MODE_UNSPECIFIED": self = .unspecified
      case "ZONE_BY_ZONE": self = .zoneByZone
      case "CONCURRENT_ZONES": self = .concurrentZones
      default: self = .unknownStringValue(stringValue)
      }
    }

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