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

/**
 * Boost specification to boost certain items.
 *
 *  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 GoogleCloudRetailV2SearchRequestBoostSpec extends com.google.api.client.json.GenericJson {

  /**
   * Condition boost specifications. If a product matches multiple conditions in the specifictions,
   * boost scores from these specifications are all applied and combined in a non-linear way.
   * Maximum number of specifications is 20.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List conditionBoostSpecs;

  /**
   * Whether to skip boostspec validation. If this field is set to true, invalid
   * BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will
   * still be applied.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean skipBoostSpecValidation;

  /**
   * Condition boost specifications. If a product matches multiple conditions in the specifictions,
   * boost scores from these specifications are all applied and combined in a non-linear way.
   * Maximum number of specifications is 20.
   * @return value or {@code null} for none
   */
  public java.util.List getConditionBoostSpecs() {
    return conditionBoostSpecs;
  }

  /**
   * Condition boost specifications. If a product matches multiple conditions in the specifictions,
   * boost scores from these specifications are all applied and combined in a non-linear way.
   * Maximum number of specifications is 20.
   * @param conditionBoostSpecs conditionBoostSpecs or {@code null} for none
   */
  public GoogleCloudRetailV2SearchRequestBoostSpec setConditionBoostSpecs(java.util.List conditionBoostSpecs) {
    this.conditionBoostSpecs = conditionBoostSpecs;
    return this;
  }

  /**
   * Whether to skip boostspec validation. If this field is set to true, invalid
   * BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will
   * still be applied.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSkipBoostSpecValidation() {
    return skipBoostSpecValidation;
  }

  /**
   * Whether to skip boostspec validation. If this field is set to true, invalid
   * BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will
   * still be applied.
   * @param skipBoostSpecValidation skipBoostSpecValidation or {@code null} for none
   */
  public GoogleCloudRetailV2SearchRequestBoostSpec setSkipBoostSpecValidation(java.lang.Boolean skipBoostSpecValidation) {
    this.skipBoostSpecValidation = skipBoostSpecValidation;
    return this;
  }

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

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

}