com.google.api.services.retail.v2.model.GoogleCloudRetailV2Condition 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-rev20250107-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;

/**
 * Metadata that is used to define a condition that triggers an action. A valid condition must
 * specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the
 * condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter
 * are set, then only items matching the product_filter for requests with a query matching the query
 * terms wil get boosted.
 *
 *  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 GoogleCloudRetailV2Condition extends com.google.api.client.json.GenericJson {

  /**
   * Range of time(s) specifying when Condition is active. Condition true if any time range matches.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List activeTimeRange;

  /**
   * Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The
   * format should be the same as UserEvent.page_categories;
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List pageCategories;

  /**
   * A list (up to 10 entries) of terms to match the query on. If not specified, match all queries.
   * If many query terms are specified, the condition is matched if any of the terms is a match
   * (i.e. using the OR operator).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List queryTerms;

  /**
   * Range of time(s) specifying when Condition is active. Condition true if any time range matches.
   * @return value or {@code null} for none
   */
  public java.util.List getActiveTimeRange() {
    return activeTimeRange;
  }

  /**
   * Range of time(s) specifying when Condition is active. Condition true if any time range matches.
   * @param activeTimeRange activeTimeRange or {@code null} for none
   */
  public GoogleCloudRetailV2Condition setActiveTimeRange(java.util.List activeTimeRange) {
    this.activeTimeRange = activeTimeRange;
    return this;
  }

  /**
   * Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The
   * format should be the same as UserEvent.page_categories;
   * @return value or {@code null} for none
   */
  public java.util.List getPageCategories() {
    return pageCategories;
  }

  /**
   * Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The
   * format should be the same as UserEvent.page_categories;
   * @param pageCategories pageCategories or {@code null} for none
   */
  public GoogleCloudRetailV2Condition setPageCategories(java.util.List pageCategories) {
    this.pageCategories = pageCategories;
    return this;
  }

  /**
   * A list (up to 10 entries) of terms to match the query on. If not specified, match all queries.
   * If many query terms are specified, the condition is matched if any of the terms is a match
   * (i.e. using the OR operator).
   * @return value or {@code null} for none
   */
  public java.util.List getQueryTerms() {
    return queryTerms;
  }

  /**
   * A list (up to 10 entries) of terms to match the query on. If not specified, match all queries.
   * If many query terms are specified, the condition is matched if any of the terms is a match
   * (i.e. using the OR operator).
   * @param queryTerms queryTerms or {@code null} for none
   */
  public GoogleCloudRetailV2Condition setQueryTerms(java.util.List queryTerms) {
    this.queryTerms = queryTerms;
    return this;
  }

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

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

}