// 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 RecommendationService || UserEventService
  import Foundation
  import GoogleCloudWkt

  /// Detailed panel information associated with a user event.
  public struct PanelInfo: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// Required. The panel ID.
    public var panelId: Swift.String = Swift.String()

    /// The display name of the panel.
    public var displayName: Swift.String = Swift.String()

    /// The ordered position of the panel, if shown to the user with other panels.
    /// If set, then
    /// [total_panels][google.cloud.discoveryengine.v1.PanelInfo.total_panels] must
    /// also be set.
    ///
    /// [google.cloud.discoveryengine.v1.PanelInfo.total_panels]: <doc:PanelInfo/totalPanels>
    public var panelPosition: Swift.Int32? = nil

    /// The total number of panels, including this one, shown to the user.
    /// Must be set if
    /// [panel_position][google.cloud.discoveryengine.v1.PanelInfo.panel_position]
    /// is set.
    ///
    /// [google.cloud.discoveryengine.v1.PanelInfo.panel_position]: <doc:PanelInfo/panelPosition>
    public var totalPanels: Swift.Int32? = nil

    /// Optional. The document IDs associated with this panel.
    public var documents: [DocumentInfo] = []

    /// Initialize a new instance of `PanelInfo`.
    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 = PanelInfo().with { $0.panelId = ... }
    /// ```
    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.discoveryengine.v1.PanelInfo"
    }
    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
