com.google.api.services.retail.v2.model.GoogleCloudRetailV2ExperimentInfo 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 for active A/B testing experiment.
 *
 *  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 GoogleCloudRetailV2ExperimentInfo extends com.google.api.client.json.GenericJson {

  /**
   * The fully qualified resource name of the experiment that provides the serving config under
   * test, should an active experiment exist. For example:
   * `projects/locations/global/catalogs/default_catalog/experiments/experiment_id`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String experiment;

  /**
   * A/B test between existing Cloud Retail Search ServingConfigs.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudRetailV2ExperimentInfoServingConfigExperiment servingConfigExperiment;

  /**
   * The fully qualified resource name of the experiment that provides the serving config under
   * test, should an active experiment exist. For example:
   * `projects/locations/global/catalogs/default_catalog/experiments/experiment_id`
   * @return value or {@code null} for none
   */
  public java.lang.String getExperiment() {
    return experiment;
  }

  /**
   * The fully qualified resource name of the experiment that provides the serving config under
   * test, should an active experiment exist. For example:
   * `projects/locations/global/catalogs/default_catalog/experiments/experiment_id`
   * @param experiment experiment or {@code null} for none
   */
  public GoogleCloudRetailV2ExperimentInfo setExperiment(java.lang.String experiment) {
    this.experiment = experiment;
    return this;
  }

  /**
   * A/B test between existing Cloud Retail Search ServingConfigs.
   * @return value or {@code null} for none
   */
  public GoogleCloudRetailV2ExperimentInfoServingConfigExperiment getServingConfigExperiment() {
    return servingConfigExperiment;
  }

  /**
   * A/B test between existing Cloud Retail Search ServingConfigs.
   * @param servingConfigExperiment servingConfigExperiment or {@code null} for none
   */
  public GoogleCloudRetailV2ExperimentInfo setServingConfigExperiment(GoogleCloudRetailV2ExperimentInfoServingConfigExperiment servingConfigExperiment) {
    this.servingConfigExperiment = servingConfigExperiment;
    return this;
  }

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

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

}