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

/// [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] specifies how
/// cryptographic operations are performed. For more information, see [Protection
/// levels] (https://cloud.google.com/kms/docs/algorithms#protection_levels).
///
/// [google.cloud.kms.v1.ProtectionLevel]: <doc:ProtectionLevel>
public enum ProtectionLevel: Codable, Equatable, Sendable {
  /// Not specified.
  case unspecified
  /// Crypto operations are performed in software.
  case software
  /// Crypto operations are performed in a Hardware Security Module.
  case hsm
  /// Crypto operations are performed by an external key manager.
  case external
  /// Crypto operations are performed in an EKM-over-VPC backend.
  case externalVpc
  /// Crypto operations are performed in a single-tenant HSM.
  case hsmSingleTenant
  /// 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 .software: return 1
    case .hsm: return 2
    case .external: return 3
    case .externalVpc: return 4
    case .hsmSingleTenant: return 5
    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 "PROTECTION_LEVEL_UNSPECIFIED"
    case .software: return "SOFTWARE"
    case .hsm: return "HSM"
    case .external: return "EXTERNAL"
    case .externalVpc: return "EXTERNAL_VPC"
    case .hsmSingleTenant: return "HSM_SINGLE_TENANT"
    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:ProtectionLevel/unknownStringValue(_:)).
  public init(stringValue: Swift.String) {
    switch stringValue {
    case "PROTECTION_LEVEL_UNSPECIFIED": self = .unspecified
    case "SOFTWARE": self = .software
    case "HSM": self = .hsm
    case "EXTERNAL": self = .external
    case "EXTERNAL_VPC": self = .externalVpc
    case "HSM_SINGLE_TENANT": self = .hsmSingleTenant
    default: self = .unknownStringValue(stringValue)
    }
  }

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