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

/// Auto-complete parameters.
public struct CompleteQueryRequest: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. Resource name of tenant the completion is performed within.
  ///
  /// The format is "projects/{project_id}/tenants/{tenant_id}", for example,
  /// "projects/foo/tenants/bar".
  public var tenant: Swift.String = Swift.String()

  /// Required. The query used to generate suggestions.
  ///
  /// The maximum number of allowed characters is 255.
  public var query: Swift.String = Swift.String()

  /// The list of languages of the query. This is
  /// the BCP-47 language code, such as "en-US" or "sr-Latn".
  /// For more information, see
  /// [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
  ///
  /// The maximum number of allowed characters is 255.
  public var languageCodes: [Swift.String] = []

  /// Required. Completion result count.
  ///
  /// The maximum allowed page size is 10.
  public var pageSize: Swift.Int32 = Swift.Int32()

  /// If provided, restricts completion to specified company.
  ///
  /// The format is
  /// "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
  /// example, "projects/foo/tenants/bar/companies/baz".
  public var company: Swift.String = Swift.String()

  /// The scope of the completion. The defaults is
  /// [CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
  ///
  /// [google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC]: <doc:CompleteQueryRequest/CompletionScope/`public`>
  public var scope: CompleteQueryRequest.CompletionScope = CompleteQueryRequest.CompletionScope()

  /// The completion topic. The default is
  /// [CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED].
  ///
  /// [google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED]: <doc:CompleteQueryRequest/CompletionType/combined>
  public var type: CompleteQueryRequest.CompletionType = CompleteQueryRequest.CompletionType()

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

  /// Enum to specify the scope of completion.
  public enum CompletionScope: Codable, Equatable, Sendable {
    /// Default value.
    case unspecified
    /// Suggestions are based only on the data provided by the client.
    case tenant
    /// Suggestions are based on all jobs data in the system that's visible to
    /// the client
    case `public`
    /// 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 .tenant: return 1
      case .`public`: 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 "COMPLETION_SCOPE_UNSPECIFIED"
      case .tenant: return "TENANT"
      case .`public`: return "PUBLIC"
      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:CompletionScope/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "COMPLETION_SCOPE_UNSPECIFIED": self = .unspecified
      case "TENANT": self = .tenant
      case "PUBLIC": self = .`public`
      default: self = .unknownStringValue(stringValue)
      }
    }

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

  /// Enum to specify auto-completion topics.
  public enum CompletionType: Codable, Equatable, Sendable {
    /// Default value.
    case unspecified
    /// Suggest job titles for jobs autocomplete.
    ///
    /// For
    /// [CompletionType.JOB_TITLE][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.JOB_TITLE]
    /// type, only open jobs with the same
    /// [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes]
    /// are returned.
    ///
    /// [google.cloud.talent.v4.CompleteQueryRequest.CompletionType.JOB_TITLE]: <doc:CompleteQueryRequest/CompletionType/jobTitle>
    /// [google.cloud.talent.v4.CompleteQueryRequest.language_codes]: <doc:CompleteQueryRequest/languageCodes>
    case jobTitle
    /// Suggest company names for jobs autocomplete.
    ///
    /// For
    /// [CompletionType.COMPANY_NAME][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMPANY_NAME]
    /// type, only companies having open jobs with the same
    /// [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes]
    /// are returned.
    ///
    /// [google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMPANY_NAME]: <doc:CompleteQueryRequest/CompletionType/companyName>
    /// [google.cloud.talent.v4.CompleteQueryRequest.language_codes]: <doc:CompleteQueryRequest/languageCodes>
    case companyName
    /// Suggest both job titles and company names for jobs autocomplete.
    ///
    /// For
    /// [CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED]
    /// type, only open jobs with the same
    /// [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes]
    /// or companies having open jobs with the same
    /// [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes]
    /// are returned.
    ///
    /// [google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED]: <doc:CompleteQueryRequest/CompletionType/combined>
    /// [google.cloud.talent.v4.CompleteQueryRequest.language_codes]: <doc:CompleteQueryRequest/languageCodes>
    case combined
    /// 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 .jobTitle: return 1
      case .companyName: return 2
      case .combined: 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 "COMPLETION_TYPE_UNSPECIFIED"
      case .jobTitle: return "JOB_TITLE"
      case .companyName: return "COMPANY_NAME"
      case .combined: return "COMBINED"
      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:CompletionType/unknownStringValue(_:)).
    public init(stringValue: Swift.String) {
      switch stringValue {
      case "COMPLETION_TYPE_UNSPECIFIED": self = .unspecified
      case "JOB_TITLE": self = .jobTitle
      case "COMPANY_NAME": self = .companyName
      case "COMBINED": self = .combined
      default: self = .unknownStringValue(stringValue)
      }
    }

    /// Initialize from an integer value.
    ///
    /// If the value is unknown, this initializes to [`unknownIntValue`](doc:CompletionType/unknownIntValue(_:)).
    public init(intValue: Int) {
      switch intValue {
      case 0: self = .unspecified
      case 1: self = .jobTitle
      case 2: self = .companyName
      case 3: self = .combined
      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 .jobTitle: return try container.encode(1)
      case .companyName: return try container.encode(2)
      case .combined: 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.talent.v4.CompleteQueryRequest"
  }
  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)
  }
}
