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

/// List GlossaryCategories Request
public struct ListGlossaryCategoriesRequest: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. The parent, which has this collection of GlossaryCategories.
  /// Format:
  /// projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
  /// Location is the Google Cloud region.
  public var parent: Swift.String = Swift.String()

  /// Optional. The maximum number of GlossaryCategories to return. The service
  /// may return fewer than this value. If unspecified, at most 50
  /// GlossaryCategories will be returned. The maximum value is 1000; values
  /// above 1000 will be coerced to 1000.
  public var pageSize: Swift.Int32 = Swift.Int32()

  /// Optional. A page token, received from a previous `ListGlossaryCategories`
  /// call. Provide this to retrieve the subsequent page. When paginating, all
  /// other parameters provided to `ListGlossaryCategories` must match the call
  /// that provided the page token.
  public var pageToken: Swift.String = Swift.String()

  /// Optional. Filter expression that filters GlossaryCategories listed in the
  /// response. Filters are supported on the following fields:
  ///   - immediate_parent
  ///
  /// Examples of using a filter are:
  ///   -
  ///   `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"`
  ///   -
  ///   `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"`
  ///
  /// This will only return the GlossaryCategories that are directly nested
  /// under the specified parent.
  public var filter: Swift.String = Swift.String()

  /// Optional. Order by expression that orders GlossaryCategories listed in the
  /// response. Order by fields are: `name` or `create_time` for the result. If
  /// not specified, the ordering is undefined.
  public var orderBy: Swift.String = Swift.String()

  /// Initialize a new instance of `ListGlossaryCategoriesRequest`.
  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 = ListGlossaryCategoriesRequest().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.dataplex.v1.ListGlossaryCategoriesRequest"
  }
  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)
  }
}
