com.google.api.services.retail.v2.model.GoogleCloudRetailV2PurgeUserEventsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-retail Show documentation
There is a newer version: v2-rev20241220-2.0.0
Show newest version
/*
 * 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.retail.v2.model;

/**
 * Request message for PurgeUserEvents method.
 *
 *  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 Retail API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudRetailV2PurgeUserEventsRequest extends com.google.api.client.json.GenericJson {

  /**
   * 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 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String filter;

  /**
   * Actually perform the purge. If `force` is set to false, the method will return the expected
   * purge count without deleting any user events.
   * 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 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 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.
   * @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 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 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.
   * @param filter filter or {@code null} for none
   */
  public GoogleCloudRetailV2PurgeUserEventsRequest setFilter(java.lang.String filter) {
    this.filter = filter;
    return this;
  }

  /**
   * Actually perform the purge. If `force` is set to false, the method will return the expected
   * purge count without deleting any user events.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getForce() {
    return force;
  }

  /**
   * Actually perform the purge. If `force` is set to false, the method will return the expected
   * purge count without deleting any user events.
   * @param force force or {@code null} for none
   */
  public GoogleCloudRetailV2PurgeUserEventsRequest setForce(java.lang.Boolean force) {
    this.force = force;
    return this;
  }

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

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

}