com.google.api.services.retail.v2.model.GoogleCloudRetailV2SearchResponse Maven / Gradle / Ivy
/*
* 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;
/**
* Response message for SearchService.Search method.
*
* 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 GoogleCloudRetailV2SearchResponse extends com.google.api.client.json.GenericJson {
/**
* The fully qualified resource name of applied
* [controls](https://cloud.google.com/retail/docs/serving-control-rules).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List appliedControls;
/**
* A unique search token. This should be included in the UserEvent logs resulting from this
* search, which enables accurate attribution of search model performance.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String attributionToken;
/**
* This field specifies all related information that is needed on client side for UI rendering of
* conversational retail search.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRetailV2SearchResponseConversationalSearchResult conversationalSearchResult;
/**
* Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then
* the search results are based on corrected_query. Otherwise the original query is used for
* search.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String correctedQuery;
/**
* Metadata related to A/B testing Experiment associated with this response. Only exists when an
* experiment is triggered.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List experimentInfo;
static {
// hack to force ProGuard to consider GoogleCloudRetailV2ExperimentInfo 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(GoogleCloudRetailV2ExperimentInfo.class);
}
/**
* Results of facets requested by user.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List facets;
/**
* The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List invalidConditionBoostSpecs;
static {
// hack to force ProGuard to consider GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec 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(GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec.class);
}
/**
* A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field
* is omitted, there are no subsequent pages.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String nextPageToken;
/**
* Query expansion information for the returned results.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRetailV2SearchResponseQueryExpansionInfo queryExpansionInfo;
/**
* The URI of a customer-defined redirect page. If redirect action is triggered, no search is
* performed, and only redirect_uri and attribution_token are set in the response.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String redirectUri;
/**
* A list of matched items. The order represents the ranking.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List results;
/**
* This field specifies all related information for tile navigation that will be used in client
* side.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudRetailV2SearchResponseTileNavigationResult tileNavigationResult;
/**
* The estimated total count of matched items irrespective of pagination. The count of results
* returned by pagination may be less than the total_size that matches.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer totalSize;
/**
* The fully qualified resource name of applied
* [controls](https://cloud.google.com/retail/docs/serving-control-rules).
* @return value or {@code null} for none
*/
public java.util.List getAppliedControls() {
return appliedControls;
}
/**
* The fully qualified resource name of applied
* [controls](https://cloud.google.com/retail/docs/serving-control-rules).
* @param appliedControls appliedControls or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setAppliedControls(java.util.List appliedControls) {
this.appliedControls = appliedControls;
return this;
}
/**
* A unique search token. This should be included in the UserEvent logs resulting from this
* search, which enables accurate attribution of search model performance.
* @return value or {@code null} for none
*/
public java.lang.String getAttributionToken() {
return attributionToken;
}
/**
* A unique search token. This should be included in the UserEvent logs resulting from this
* search, which enables accurate attribution of search model performance.
* @param attributionToken attributionToken or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setAttributionToken(java.lang.String attributionToken) {
this.attributionToken = attributionToken;
return this;
}
/**
* This field specifies all related information that is needed on client side for UI rendering of
* conversational retail search.
* @return value or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponseConversationalSearchResult getConversationalSearchResult() {
return conversationalSearchResult;
}
/**
* This field specifies all related information that is needed on client side for UI rendering of
* conversational retail search.
* @param conversationalSearchResult conversationalSearchResult or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setConversationalSearchResult(GoogleCloudRetailV2SearchResponseConversationalSearchResult conversationalSearchResult) {
this.conversationalSearchResult = conversationalSearchResult;
return this;
}
/**
* Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then
* the search results are based on corrected_query. Otherwise the original query is used for
* search.
* @return value or {@code null} for none
*/
public java.lang.String getCorrectedQuery() {
return correctedQuery;
}
/**
* Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then
* the search results are based on corrected_query. Otherwise the original query is used for
* search.
* @param correctedQuery correctedQuery or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setCorrectedQuery(java.lang.String correctedQuery) {
this.correctedQuery = correctedQuery;
return this;
}
/**
* Metadata related to A/B testing Experiment associated with this response. Only exists when an
* experiment is triggered.
* @return value or {@code null} for none
*/
public java.util.List getExperimentInfo() {
return experimentInfo;
}
/**
* Metadata related to A/B testing Experiment associated with this response. Only exists when an
* experiment is triggered.
* @param experimentInfo experimentInfo or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setExperimentInfo(java.util.List experimentInfo) {
this.experimentInfo = experimentInfo;
return this;
}
/**
* Results of facets requested by user.
* @return value or {@code null} for none
*/
public java.util.List getFacets() {
return facets;
}
/**
* Results of facets requested by user.
* @param facets facets or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setFacets(java.util.List facets) {
this.facets = facets;
return this;
}
/**
* The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
* @return value or {@code null} for none
*/
public java.util.List getInvalidConditionBoostSpecs() {
return invalidConditionBoostSpecs;
}
/**
* The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
* @param invalidConditionBoostSpecs invalidConditionBoostSpecs or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setInvalidConditionBoostSpecs(java.util.List invalidConditionBoostSpecs) {
this.invalidConditionBoostSpecs = invalidConditionBoostSpecs;
return this;
}
/**
* A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field
* is omitted, there are no subsequent pages.
* @return value or {@code null} for none
*/
public java.lang.String getNextPageToken() {
return nextPageToken;
}
/**
* A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field
* is omitted, there are no subsequent pages.
* @param nextPageToken nextPageToken or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setNextPageToken(java.lang.String nextPageToken) {
this.nextPageToken = nextPageToken;
return this;
}
/**
* Query expansion information for the returned results.
* @return value or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponseQueryExpansionInfo getQueryExpansionInfo() {
return queryExpansionInfo;
}
/**
* Query expansion information for the returned results.
* @param queryExpansionInfo queryExpansionInfo or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setQueryExpansionInfo(GoogleCloudRetailV2SearchResponseQueryExpansionInfo queryExpansionInfo) {
this.queryExpansionInfo = queryExpansionInfo;
return this;
}
/**
* The URI of a customer-defined redirect page. If redirect action is triggered, no search is
* performed, and only redirect_uri and attribution_token are set in the response.
* @return value or {@code null} for none
*/
public java.lang.String getRedirectUri() {
return redirectUri;
}
/**
* The URI of a customer-defined redirect page. If redirect action is triggered, no search is
* performed, and only redirect_uri and attribution_token are set in the response.
* @param redirectUri redirectUri or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setRedirectUri(java.lang.String redirectUri) {
this.redirectUri = redirectUri;
return this;
}
/**
* A list of matched items. The order represents the ranking.
* @return value or {@code null} for none
*/
public java.util.List getResults() {
return results;
}
/**
* A list of matched items. The order represents the ranking.
* @param results results or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setResults(java.util.List results) {
this.results = results;
return this;
}
/**
* This field specifies all related information for tile navigation that will be used in client
* side.
* @return value or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponseTileNavigationResult getTileNavigationResult() {
return tileNavigationResult;
}
/**
* This field specifies all related information for tile navigation that will be used in client
* side.
* @param tileNavigationResult tileNavigationResult or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setTileNavigationResult(GoogleCloudRetailV2SearchResponseTileNavigationResult tileNavigationResult) {
this.tileNavigationResult = tileNavigationResult;
return this;
}
/**
* The estimated total count of matched items irrespective of pagination. The count of results
* returned by pagination may be less than the total_size that matches.
* @return value or {@code null} for none
*/
public java.lang.Integer getTotalSize() {
return totalSize;
}
/**
* The estimated total count of matched items irrespective of pagination. The count of results
* returned by pagination may be less than the total_size that matches.
* @param totalSize totalSize or {@code null} for none
*/
public GoogleCloudRetailV2SearchResponse setTotalSize(java.lang.Integer totalSize) {
this.totalSize = totalSize;
return this;
}
@Override
public GoogleCloudRetailV2SearchResponse set(String fieldName, Object value) {
return (GoogleCloudRetailV2SearchResponse) super.set(fieldName, value);
}
@Override
public GoogleCloudRetailV2SearchResponse clone() {
return (GoogleCloudRetailV2SearchResponse) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy