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

/// Contains an HSM-generated attestation about a key operation. For more
/// information, see [Verifying attestations]
/// (https://cloud.google.com/kms/docs/attest-key).
public struct KeyOperationAttestation: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Output only. The format of the attestation data.
  public var format: KeyOperationAttestation.AttestationFormat =
    KeyOperationAttestation.AttestationFormat()

  /// Output only. The attestation data provided by the HSM when the key
  /// operation was performed.
  public var content: Foundation.Data = Foundation.Data()

  /// Output only. The certificate chains needed to validate the attestation
  public var certChains: KeyOperationAttestation.CertificateChains? = nil

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

  /// Certificate chains needed to verify the attestation.
  /// Certificates in chains are PEM-encoded and are ordered based on
  /// https://tools.ietf.org/html/rfc5246#section-7.4.2.
  public struct CertificateChains: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// Cavium certificate chain corresponding to the attestation.
    public var caviumCerts: [Swift.String] = []

    /// Google card certificate chain corresponding to the attestation.
    public var googleCardCerts: [Swift.String] = []

    /// Google partition certificate chain corresponding to the attestation.
    public var googlePartitionCerts: [Swift.String] = []

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

    public static var _anyTypeUrl: Swift.String {
      return "type.googleapis.com/google.cloud.kms.v1.KeyOperationAttestation.CertificateChains"
    }
    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)
    }
  }

  /// Attestation formats provided by the HSM.
  public enum AttestationFormat: Codable, Equatable, Sendable {
    /// Not specified.
    case unspecified
    /// Cavium HSM attestation compressed with gzip. Note that this format is
    /// defined by Cavium and subject to change at any time.
    ///
    /// See
    /// https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html.
    case caviumV1Compressed
    /// Cavium HSM attestation V2 compressed with gzip. This is a new format
    /// introduced in Cavium's version 3.2-08.
    case caviumV2Compressed
    /// 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 .caviumV1Compressed: return 3
      case .caviumV2Compressed: return 4
      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 "ATTESTATION_FORMAT_UNSPECIFIED"
      case .caviumV1Compressed: return "CAVIUM_V1_COMPRESSED"
      case .caviumV2Compressed: return "CAVIUM_V2_COMPRESSED"
      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:AttestationFormat/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "ATTESTATION_FORMAT_UNSPECIFIED": self = .unspecified
      case "CAVIUM_V1_COMPRESSED": self = .caviumV1Compressed
      case "CAVIUM_V2_COMPRESSED": self = .caviumV2Compressed
      default: self = .unknownStringValue(stringValue)
      }
    }

    /// Initialize from an integer value.
    ///
    /// If the value is unknown, this initializes to [`unknownIntValue`](doc:AttestationFormat/unknownIntValue(_:)).
    public init(intValue: Int) {
      switch intValue {
      case 0: self = .unspecified
      case 3: self = .caviumV1Compressed
      case 4: self = .caviumV2Compressed
      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 .caviumV1Compressed: return try container.encode(3)
      case .caviumV2Compressed: return try container.encode(4)
      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.kms.v1.KeyOperationAttestation"
  }
  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)
  }
}
