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

Go to download
/*
 * 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;

/**
 * Replaces a term in the query. Multiple replacement candidates can be specified. All `query_terms`
 * will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
 *
 *  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 GoogleCloudRetailV2RuleReplacementAction extends com.google.api.client.json.GenericJson {

  /**
   * Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List queryTerms;

  /**
   * Term that will be used for replacement.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String replacementTerm;

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

  /**
   * Terms from the search query. Will be replaced by replacement term. 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 be replaced by replacement term. Can specify up to 100 terms.
   * @param queryTerms queryTerms or {@code null} for none
   */
  public GoogleCloudRetailV2RuleReplacementAction setQueryTerms(java.util.List queryTerms) {
    this.queryTerms = queryTerms;
    return this;
  }

  /**
   * Term that will be used for replacement.
   * @return value or {@code null} for none
   */
  public java.lang.String getReplacementTerm() {
    return replacementTerm;
  }

  /**
   * Term that will be used for replacement.
   * @param replacementTerm replacementTerm or {@code null} for none
   */
  public GoogleCloudRetailV2RuleReplacementAction setReplacementTerm(java.lang.String replacementTerm) {
    this.replacementTerm = replacementTerm;
    return this;
  }

  /**
   * Will be [deprecated = true] post migration;
   * @return value or {@code null} for none
   */
  public java.lang.String getTerm() {
    return term;
  }

  /**
   * Will be [deprecated = true] post migration;
   * @param term term or {@code null} for none
   */
  public GoogleCloudRetailV2RuleReplacementAction setTerm(java.lang.String term) {
    this.term = term;
    return this;
  }

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

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

}