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

/**
 * Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each
 * query term only. `query_terms` will not be treated as synonyms of each other. Example: "sneakers"
 * will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
 *
 *  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 GoogleCloudRetailV2RuleOnewaySynonymsAction extends com.google.api.client.json.GenericJson {

  /**
   * Will be [deprecated = true] post migration;
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List onewayTerms;

  /**
   * Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of
   * the synonyms. Can specify up to 100 terms.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List queryTerms;

  /**
   * Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List synonyms;

  /**
   * Will be [deprecated = true] post migration;
   * @return value or {@code null} for none
   */
  public java.util.List getOnewayTerms() {
    return onewayTerms;
  }

  /**
   * Will be [deprecated = true] post migration;
   * @param onewayTerms onewayTerms or {@code null} for none
   */
  public GoogleCloudRetailV2RuleOnewaySynonymsAction setOnewayTerms(java.util.List onewayTerms) {
    this.onewayTerms = onewayTerms;
    return this;
  }

  /**
   * Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of
   * the synonyms. Can specify up to 100 terms.
   * @return value or {@code null} for none
   */
  public java.util.List getQueryTerms() {
    return queryTerms;
  }

  /**
   * Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of
   * the synonyms. Can specify up to 100 terms.
   * @param queryTerms queryTerms or {@code null} for none
   */
  public GoogleCloudRetailV2RuleOnewaySynonymsAction setQueryTerms(java.util.List queryTerms) {
    this.queryTerms = queryTerms;
    return this;
  }

  /**
   * Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
   * @return value or {@code null} for none
   */
  public java.util.List getSynonyms() {
    return synonyms;
  }

  /**
   * Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
   * @param synonyms synonyms or {@code null} for none
   */
  public GoogleCloudRetailV2RuleOnewaySynonymsAction setSynonyms(java.util.List synonyms) {
    this.synonyms = synonyms;
    return this;
  }

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

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

}