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

/// Request for ListControls method.
public struct ListControlsRequest: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. The catalog resource name. Format:
  /// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
  public var parent: Swift.String = Swift.String()

  /// Optional. Maximum number of results to return. If unspecified, defaults
  /// to 50. Max allowed value is 1000.
  public var pageSize: Swift.Int32 = Swift.Int32()

  /// Optional. A page token, received from a previous `ListControls` call.
  /// Provide this to retrieve the subsequent page.
  public var pageToken: Swift.String = Swift.String()

  /// Optional. A filter to apply on the list results. Supported features:
  ///
  /// * List all the products under the parent branch if
  /// [filter][google.cloud.retail.v2.ListControlsRequest.filter] is unset.
  /// * List controls that are used in a single ServingConfig:
  ///     'serving_config = "boosted_home_page_cvr"'
  ///
  /// [google.cloud.retail.v2.ListControlsRequest.filter]: <doc:ListControlsRequest/filter>
  public var filter: Swift.String = Swift.String()

  /// Initialize a new instance of `ListControlsRequest`.
  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 = ListControlsRequest().with { $0.parent = ... }
  /// ```
  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.retail.v2.ListControlsRequest"
  }
  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)
  }
}
