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

/**
 * Information describing query expansion including whether expansion has occurred.
 *
 *  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 GoogleCloudRetailV2SearchResponseQueryExpansionInfo extends com.google.api.client.json.GenericJson {

  /**
   * Bool describing whether query expansion has occurred.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean expandedQuery;

  /**
   * Number of pinned results. This field will only be set when expansion happens and
   * SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long pinnedResultCount;

  /**
   * Bool describing whether query expansion has occurred.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getExpandedQuery() {
    return expandedQuery;
  }

  /**
   * Bool describing whether query expansion has occurred.
   * @param expandedQuery expandedQuery or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseQueryExpansionInfo setExpandedQuery(java.lang.Boolean expandedQuery) {
    this.expandedQuery = expandedQuery;
    return this;
  }

  /**
   * Number of pinned results. This field will only be set when expansion happens and
   * SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
   * @return value or {@code null} for none
   */
  public java.lang.Long getPinnedResultCount() {
    return pinnedResultCount;
  }

  /**
   * Number of pinned results. This field will only be set when expansion happens and
   * SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
   * @param pinnedResultCount pinnedResultCount or {@code null} for none
   */
  public GoogleCloudRetailV2SearchResponseQueryExpansionInfo setPinnedResultCount(java.lang.Long pinnedResultCount) {
    this.pinnedResultCount = pinnedResultCount;
    return this;
  }

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

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

}