com.google.api.services.retail.v2.model.GoogleCloudRetailV2ExportAnalyticsMetricsRequest 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
The 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 the `ExportAnalyticsMetrics` 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 Vertex AI Search for 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 GoogleCloudRetailV2ExportAnalyticsMetricsRequest extends com.google.api.client.json.GenericJson {

  /**
   * A filtering expression to specify restrictions on returned metrics. The expression is a
   * sequence of terms. Each term applies a restriction to the returned metrics. Use this expression
   * to restrict results to a specific time range. Currently we expect only one types of fields: *
   * `timestamp`: This can be specified twice, once with a less than operator and once with a
   * greater than operator. The `timestamp` restriction should result in one, contiguous, valid,
   * `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp >
   * "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"` * Example 2: `timestamp >
   * "2012-04-23T18:25:43.511Z"`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String filter;

  /**
   * Required. The output location of the data.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudRetailV2OutputConfig outputConfig;

  /**
   * A filtering expression to specify restrictions on returned metrics. The expression is a
   * sequence of terms. Each term applies a restriction to the returned metrics. Use this expression
   * to restrict results to a specific time range. Currently we expect only one types of fields: *
   * `timestamp`: This can be specified twice, once with a less than operator and once with a
   * greater than operator. The `timestamp` restriction should result in one, contiguous, valid,
   * `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp >
   * "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"` * Example 2: `timestamp >
   * "2012-04-23T18:25:43.511Z"`
   * @return value or {@code null} for none
   */
  public java.lang.String getFilter() {
    return filter;
  }

  /**
   * A filtering expression to specify restrictions on returned metrics. The expression is a
   * sequence of terms. Each term applies a restriction to the returned metrics. Use this expression
   * to restrict results to a specific time range. Currently we expect only one types of fields: *
   * `timestamp`: This can be specified twice, once with a less than operator and once with a
   * greater than operator. The `timestamp` restriction should result in one, contiguous, valid,
   * `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp >
   * "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z"` * Example 2: `timestamp >
   * "2012-04-23T18:25:43.511Z"`
   * @param filter filter or {@code null} for none
   */
  public GoogleCloudRetailV2ExportAnalyticsMetricsRequest setFilter(java.lang.String filter) {
    this.filter = filter;
    return this;
  }

  /**
   * Required. The output location of the data.
   * @return value or {@code null} for none
   */
  public GoogleCloudRetailV2OutputConfig getOutputConfig() {
    return outputConfig;
  }

  /**
   * Required. The output location of the data.
   * @param outputConfig outputConfig or {@code null} for none
   */
  public GoogleCloudRetailV2ExportAnalyticsMetricsRequest setOutputConfig(GoogleCloudRetailV2OutputConfig outputConfig) {
    this.outputConfig = outputConfig;
    return this;
  }

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

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

}