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

/**
 * An individual panel with a list of ServingConfigs to consider for it.
 *
 *  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 GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel extends com.google.api.client.json.GenericJson {

  /**
   * Required. The candidates to consider on the panel.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List candidates;

  static {
    // hack to force ProGuard to consider GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate.class);
  }

  /**
   * Required. The default candidate. If the model fails at serving time, we fall back to the
   * default.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate defaultCandidate;

  /**
   * Optional. The name to display for the panel.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Required. The candidates to consider on the panel.
   * @return value or {@code null} for none
   */
  public java.util.List getCandidates() {
    return candidates;
  }

  /**
   * Required. The candidates to consider on the panel.
   * @param candidates candidates or {@code null} for none
   */
  public GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel setCandidates(java.util.List candidates) {
    this.candidates = candidates;
    return this;
  }

  /**
   * Required. The default candidate. If the model fails at serving time, we fall back to the
   * default.
   * @return value or {@code null} for none
   */
  public GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate getDefaultCandidate() {
    return defaultCandidate;
  }

  /**
   * Required. The default candidate. If the model fails at serving time, we fall back to the
   * default.
   * @param defaultCandidate defaultCandidate or {@code null} for none
   */
  public GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel setDefaultCandidate(GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate defaultCandidate) {
    this.defaultCandidate = defaultCandidate;
    return this;
  }

  /**
   * Optional. The name to display for the panel.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Optional. The name to display for the panel.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

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

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

}