/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.recommendationengine.v1beta1.model;

/**
 * Request message for PurgeUserEvents method.
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Recommendations AI. For a detailed explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. The filter string to specify the events to be deleted. Empty string filter is not
   * allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of
   * type string. * `eventTime`: in ISO 8601 "zulu" format. * `visitorId`: field of type string.
   * Specifying this will delete all events associated with a visitor. * `userId`: field of type
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String filter;

  /**
   * Optional. The default value is false. Override this flag to true to actually perform the purge.
   * If the field is not set to true, a sampling of events to be deleted will be returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean force;

  /**
   * Required. The filter string to specify the events to be deleted. Empty string filter is not
   * allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of
   * type string. * `eventTime`: in ISO 8601 "zulu" format. * `visitorId`: field of type string.
   * Specifying this will delete all events associated with a visitor. * `userId`: field of type
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getFilter() {
    return filter;
  }

  /**
   * Required. The filter string to specify the events to be deleted. Empty string filter is not
   * allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of
   * type string. * `eventTime`: in ISO 8601 "zulu" format. * `visitorId`: field of type string.
   * Specifying this will delete all events associated with a visitor. * `userId`: field of type
   * 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.
   * @param filter filter or {@code null} for none
   */
  public GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest setFilter(java.lang.String filter) {
    this.filter = filter;
    return this;
  }

  /**
   * Optional. The default value is false. Override this flag to true to actually perform the purge.
   * If the field is not set to true, a sampling of events to be deleted will be returned.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getForce() {
    return force;
  }

  /**
   * Optional. The default value is false. Override this flag to true to actually perform the purge.
   * If the field is not set to true, a sampling of events to be deleted will be returned.
   * @param force force or {@code null} for none
   */
  public GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest setForce(java.lang.Boolean force) {
    this.force = force;
    return this;
  }

  @Override
  public GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest set(String fieldName, Object value) {
    return (GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest clone() {
    return (GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest) super.clone();
  }

}
