// 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 message for PurgeUserEvents method.
public struct PurgeUserEventsRequest: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. The resource name of the catalog under which the events are
  /// created. The format is
  /// `projects/${projectId}/locations/global/catalogs/${catalogId}`
  public var parent: Swift.String = Swift.String()

  /// Required. The filter string to specify the events to be deleted with a
  /// length limit of 5,000 characters. Empty string filter is not allowed. The
  /// eligible fields for filtering are:
  ///
  /// * `eventType`: Double quoted
  /// [UserEvent.event_type][google.cloud.retail.v2.UserEvent.event_type] string.
  /// * `eventTime`: in ISO 8601 "zulu" format.
  /// * `visitorId`: Double quoted string. Specifying this will delete all
  ///   events associated with a visitor.
  /// * `userId`: Double quoted string. Specifying this will delete all events
  ///   associated with a user.
  ///
  /// Examples:
  ///
  /// * Deleting all events in a time range:
  ///   `eventTime > "2012-04-23T18:25:43.511Z"
  ///   eventTime < "2012-04-23T18:30:43.511Z"`
  /// * Deleting specific eventType in time range:
  ///   `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
  /// * Deleting all events for a specific visitor:
  ///   `visitorId = "visitor1024"`
  ///
  /// The filtering fields are assumed to have an implicit AND.
  ///
  /// [google.cloud.retail.v2.UserEvent.event_type]: <doc:UserEvent/eventType>
  public var filter: Swift.String = Swift.String()

  /// Actually perform the purge.
  /// If `force` is set to false, the method will return the expected purge count
  /// without deleting any user events.
  public var force: Swift.Bool = Swift.Bool()

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