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

/**
 * Configuration for overall generative question feature state.
 *
 *  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 GoogleCloudRetailV2GenerativeQuestionsFeatureConfig extends com.google.api.client.json.GenericJson {

  /**
   * Required. Resource name of the affected catalog. Format:
   * projects/{project}/locations/{location}/catalogs/{catalog}
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String catalog;

  /**
   * Optional. Determines whether questions will be used at serving time. Note: This feature cannot
   * be enabled until initial data requirements are satisfied.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean featureEnabled;

  /**
   * Optional. Minimum number of products in the response to trigger follow-up questions. Value must
   * be 0 or positive.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer minimumProducts;

  /**
   * Required. Resource name of the affected catalog. Format:
   * projects/{project}/locations/{location}/catalogs/{catalog}
   * @return value or {@code null} for none
   */
  public java.lang.String getCatalog() {
    return catalog;
  }

  /**
   * Required. Resource name of the affected catalog. Format:
   * projects/{project}/locations/{location}/catalogs/{catalog}
   * @param catalog catalog or {@code null} for none
   */
  public GoogleCloudRetailV2GenerativeQuestionsFeatureConfig setCatalog(java.lang.String catalog) {
    this.catalog = catalog;
    return this;
  }

  /**
   * Optional. Determines whether questions will be used at serving time. Note: This feature cannot
   * be enabled until initial data requirements are satisfied.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getFeatureEnabled() {
    return featureEnabled;
  }

  /**
   * Optional. Determines whether questions will be used at serving time. Note: This feature cannot
   * be enabled until initial data requirements are satisfied.
   * @param featureEnabled featureEnabled or {@code null} for none
   */
  public GoogleCloudRetailV2GenerativeQuestionsFeatureConfig setFeatureEnabled(java.lang.Boolean featureEnabled) {
    this.featureEnabled = featureEnabled;
    return this;
  }

  /**
   * Optional. Minimum number of products in the response to trigger follow-up questions. Value must
   * be 0 or positive.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMinimumProducts() {
    return minimumProducts;
  }

  /**
   * Optional. Minimum number of products in the response to trigger follow-up questions. Value must
   * be 0 or positive.
   * @param minimumProducts minimumProducts or {@code null} for none
   */
  public GoogleCloudRetailV2GenerativeQuestionsFeatureConfig setMinimumProducts(java.lang.Integer minimumProducts) {
    this.minimumProducts = minimumProducts;
    return this;
  }

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

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

}