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

#if DocumentService
  import Foundation
  import GoogleCloudWkt

  /// Response message for
  /// [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata]
  /// method.
  ///
  /// [google.cloud.discoveryengine.v1.DocumentService.BatchGetDocumentsMetadata]: <doc:DocumentService/batchGetDocumentsMetadata(request:)>
  public struct BatchGetDocumentsMetadataResponse: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// The metadata of the [Document][google.cloud.discoveryengine.v1.Document]s.
    ///
    /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
    public var documentsMetadata: [BatchGetDocumentsMetadataResponse.DocumentMetadata] = []

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

    /// The metadata of a [Document][google.cloud.discoveryengine.v1.Document].
    ///
    /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
    public struct DocumentMetadata: Codable, Equatable, GoogleCloudWkt._AnyPackable,
      Sendable
    {
      /// The value of the matcher that was used to match the
      /// [Document][google.cloud.discoveryengine.v1.Document].
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      public var matcherValue: BatchGetDocumentsMetadataResponse.DocumentMetadata.MatcherValue? =
        nil

      /// The state of the document.
      public var state: BatchGetDocumentsMetadataResponse.State =
        BatchGetDocumentsMetadataResponse.State()

      /// The timestamp of the last time the
      /// [Document][google.cloud.discoveryengine.v1.Document] was last indexed.
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      public var lastRefreshedTime: GoogleCloudWkt.Timestamp? = nil

      /// The data ingestion source of the
      /// [Document][google.cloud.discoveryengine.v1.Document].
      ///
      /// Allowed values are:
      ///
      /// * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
      /// * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      public var dataIngestionSource: Swift.String = Swift.String()

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

      /// The value of the matcher that was used to match the
      /// [Document][google.cloud.discoveryengine.v1.Document].
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      public struct MatcherValue: Codable, Equatable, GoogleCloudWkt._AnyPackable,
        Sendable
      {
        /// The value of the matcher that was used to match the
        /// [Document][google.cloud.discoveryengine.v1.Document].
        ///
        /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
        public var matcherValue: OneOf_MatcherValue? = nil

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

        private enum CodingKeys: Swift.String, CodingKey {
          case uri = "uri"
          case fhirResource = "fhirResource"
        }

        public init(from decoder: Decoder) throws {
          let container = try decoder.container(keyedBy: CodingKeys.self)

          var matcherValue: OneOf_MatcherValue? = nil
          let matcherValueCheckAndSet = {
            if matcherValue != nil {
              throw DecodingError.dataCorrupted(
                DecodingError.Context(
                  codingPath: decoder.codingPath,
                  debugDescription: "Multiple values set for oneof 'matcherValue'"))
            }
            matcherValue = $0
          }
          if let uri = try container.decodeIfPresent(Swift.String.self, forKey: .uri) {
            try matcherValueCheckAndSet(.uri(uri))
          }
          if let fhirResource = try container.decodeIfPresent(
            Swift.String.self, forKey: .fhirResource)
          {
            try matcherValueCheckAndSet(.fhirResource(fhirResource))
          }
          self.matcherValue = matcherValue
        }

        public func encode(to encoder: Encoder) throws {
          var container = encoder.container(keyedBy: CodingKeys.self)

          if let choice = self.matcherValue {
            switch choice {
            case .uri(let value):
              try container.encode(value, forKey: .uri)
            case .fhirResource(let value):
              try container.encode(value, forKey: .fhirResource)
            }
          }
        }

        /// The value of the matcher that was used to match the
        /// [Document][google.cloud.discoveryengine.v1.Document].
        ///
        /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
        public enum OneOf_MatcherValue: Codable, Equatable, Sendable {
          /// If match by URI, the URI of the
          /// [Document][google.cloud.discoveryengine.v1.Document].
          ///
          /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
          case uri(Swift.String)
          /// Format:
          /// projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
          case fhirResource(Swift.String)
        }

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

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

    /// The state of the [Document][google.cloud.discoveryengine.v1.Document].
    ///
    /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
    public enum State: Codable, Equatable, Sendable {
      /// Should never be set.
      case unspecified
      /// The [Document][google.cloud.discoveryengine.v1.Document] is indexed.
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      case indexed
      /// The [Document][google.cloud.discoveryengine.v1.Document] is not indexed
      /// because its URI is not in the
      /// [TargetSite][google.cloud.discoveryengine.v1.TargetSite].
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      /// [google.cloud.discoveryengine.v1.TargetSite]: <doc:TargetSite>
      case notInTargetSite
      /// The [Document][google.cloud.discoveryengine.v1.Document] is not indexed.
      ///
      /// [google.cloud.discoveryengine.v1.Document]: <doc:Document>
      case notInIndex
      /// 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 .indexed: return 1
        case .notInTargetSite: return 2
        case .notInIndex: return 3
        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 "STATE_UNSPECIFIED"
        case .indexed: return "INDEXED"
        case .notInTargetSite: return "NOT_IN_TARGET_SITE"
        case .notInIndex: return "NOT_IN_INDEX"
        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:State/unknownStringValue(_:)).
      public init(stringValue: Swift.String) {
        switch stringValue {
        case "STATE_UNSPECIFIED": self = .unspecified
        case "INDEXED": self = .indexed
        case "NOT_IN_TARGET_SITE": self = .notInTargetSite
        case "NOT_IN_INDEX": self = .notInIndex
        default: self = .unknownStringValue(stringValue)
        }
      }

      /// Initialize from an integer value.
      ///
      /// If the value is unknown, this initializes to [`unknownIntValue`](doc:State/unknownIntValue(_:)).
      public init(intValue: Int) {
        switch intValue {
        case 0: self = .unspecified
        case 1: self = .indexed
        case 2: self = .notInTargetSite
        case 3: self = .notInIndex
        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 .indexed: return try container.encode(1)
        case .notInTargetSite: return try container.encode(2)
        case .notInIndex: return try container.encode(3)
        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.discoveryengine.v1.BatchGetDocumentsMetadataResponse"
    }
    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)
    }
  }
#endif
