1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/retail/v2/search_service.proto 18 19 package com.google.cloud.retail.v2; 20 21 public interface SearchResponseOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.SearchResponse) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * A list of matched items. The order represents the ranking. 31 * </pre> 32 * 33 * <code>repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;</code> 34 */ getResultsList()35 java.util.List<com.google.cloud.retail.v2.SearchResponse.SearchResult> getResultsList(); 36 /** 37 * 38 * 39 * <pre> 40 * A list of matched items. The order represents the ranking. 41 * </pre> 42 * 43 * <code>repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;</code> 44 */ getResults(int index)45 com.google.cloud.retail.v2.SearchResponse.SearchResult getResults(int index); 46 /** 47 * 48 * 49 * <pre> 50 * A list of matched items. The order represents the ranking. 51 * </pre> 52 * 53 * <code>repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;</code> 54 */ getResultsCount()55 int getResultsCount(); 56 /** 57 * 58 * 59 * <pre> 60 * A list of matched items. The order represents the ranking. 61 * </pre> 62 * 63 * <code>repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;</code> 64 */ 65 java.util.List<? extends com.google.cloud.retail.v2.SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()66 getResultsOrBuilderList(); 67 /** 68 * 69 * 70 * <pre> 71 * A list of matched items. The order represents the ranking. 72 * </pre> 73 * 74 * <code>repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;</code> 75 */ getResultsOrBuilder(int index)76 com.google.cloud.retail.v2.SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index); 77 78 /** 79 * 80 * 81 * <pre> 82 * Results of facets requested by user. 83 * </pre> 84 * 85 * <code>repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;</code> 86 */ getFacetsList()87 java.util.List<com.google.cloud.retail.v2.SearchResponse.Facet> getFacetsList(); 88 /** 89 * 90 * 91 * <pre> 92 * Results of facets requested by user. 93 * </pre> 94 * 95 * <code>repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;</code> 96 */ getFacets(int index)97 com.google.cloud.retail.v2.SearchResponse.Facet getFacets(int index); 98 /** 99 * 100 * 101 * <pre> 102 * Results of facets requested by user. 103 * </pre> 104 * 105 * <code>repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;</code> 106 */ getFacetsCount()107 int getFacetsCount(); 108 /** 109 * 110 * 111 * <pre> 112 * Results of facets requested by user. 113 * </pre> 114 * 115 * <code>repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;</code> 116 */ 117 java.util.List<? extends com.google.cloud.retail.v2.SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()118 getFacetsOrBuilderList(); 119 /** 120 * 121 * 122 * <pre> 123 * Results of facets requested by user. 124 * </pre> 125 * 126 * <code>repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;</code> 127 */ getFacetsOrBuilder(int index)128 com.google.cloud.retail.v2.SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index); 129 130 /** 131 * 132 * 133 * <pre> 134 * The estimated total count of matched items irrespective of pagination. The 135 * count of [results][google.cloud.retail.v2.SearchResponse.results] returned 136 * by pagination may be less than the 137 * [total_size][google.cloud.retail.v2.SearchResponse.total_size] that 138 * matches. 139 * </pre> 140 * 141 * <code>int32 total_size = 3;</code> 142 * 143 * @return The totalSize. 144 */ getTotalSize()145 int getTotalSize(); 146 147 /** 148 * 149 * 150 * <pre> 151 * Contains the spell corrected query, if found. If the spell correction type 152 * is AUTOMATIC, then the search results are based on corrected_query. 153 * Otherwise the original query is used for search. 154 * </pre> 155 * 156 * <code>string corrected_query = 4;</code> 157 * 158 * @return The correctedQuery. 159 */ getCorrectedQuery()160 java.lang.String getCorrectedQuery(); 161 /** 162 * 163 * 164 * <pre> 165 * Contains the spell corrected query, if found. If the spell correction type 166 * is AUTOMATIC, then the search results are based on corrected_query. 167 * Otherwise the original query is used for search. 168 * </pre> 169 * 170 * <code>string corrected_query = 4;</code> 171 * 172 * @return The bytes for correctedQuery. 173 */ getCorrectedQueryBytes()174 com.google.protobuf.ByteString getCorrectedQueryBytes(); 175 176 /** 177 * 178 * 179 * <pre> 180 * A unique search token. This should be included in the 181 * [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this 182 * search, which enables accurate attribution of search model performance. 183 * </pre> 184 * 185 * <code>string attribution_token = 5;</code> 186 * 187 * @return The attributionToken. 188 */ getAttributionToken()189 java.lang.String getAttributionToken(); 190 /** 191 * 192 * 193 * <pre> 194 * A unique search token. This should be included in the 195 * [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this 196 * search, which enables accurate attribution of search model performance. 197 * </pre> 198 * 199 * <code>string attribution_token = 5;</code> 200 * 201 * @return The bytes for attributionToken. 202 */ getAttributionTokenBytes()203 com.google.protobuf.ByteString getAttributionTokenBytes(); 204 205 /** 206 * 207 * 208 * <pre> 209 * A token that can be sent as 210 * [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token] 211 * to retrieve the next page. If this field is omitted, there are no 212 * subsequent pages. 213 * </pre> 214 * 215 * <code>string next_page_token = 6;</code> 216 * 217 * @return The nextPageToken. 218 */ getNextPageToken()219 java.lang.String getNextPageToken(); 220 /** 221 * 222 * 223 * <pre> 224 * A token that can be sent as 225 * [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token] 226 * to retrieve the next page. If this field is omitted, there are no 227 * subsequent pages. 228 * </pre> 229 * 230 * <code>string next_page_token = 6;</code> 231 * 232 * @return The bytes for nextPageToken. 233 */ getNextPageTokenBytes()234 com.google.protobuf.ByteString getNextPageTokenBytes(); 235 236 /** 237 * 238 * 239 * <pre> 240 * Query expansion information for the returned results. 241 * </pre> 242 * 243 * <code>.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7; 244 * </code> 245 * 246 * @return Whether the queryExpansionInfo field is set. 247 */ hasQueryExpansionInfo()248 boolean hasQueryExpansionInfo(); 249 /** 250 * 251 * 252 * <pre> 253 * Query expansion information for the returned results. 254 * </pre> 255 * 256 * <code>.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7; 257 * </code> 258 * 259 * @return The queryExpansionInfo. 260 */ getQueryExpansionInfo()261 com.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo getQueryExpansionInfo(); 262 /** 263 * 264 * 265 * <pre> 266 * Query expansion information for the returned results. 267 * </pre> 268 * 269 * <code>.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7; 270 * </code> 271 */ 272 com.google.cloud.retail.v2.SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()273 getQueryExpansionInfoOrBuilder(); 274 275 /** 276 * 277 * 278 * <pre> 279 * The URI of a customer-defined redirect page. If redirect action is 280 * triggered, no search is performed, and only 281 * [redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri] and 282 * [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token] 283 * are set in the response. 284 * </pre> 285 * 286 * <code>string redirect_uri = 10;</code> 287 * 288 * @return The redirectUri. 289 */ getRedirectUri()290 java.lang.String getRedirectUri(); 291 /** 292 * 293 * 294 * <pre> 295 * The URI of a customer-defined redirect page. If redirect action is 296 * triggered, no search is performed, and only 297 * [redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri] and 298 * [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token] 299 * are set in the response. 300 * </pre> 301 * 302 * <code>string redirect_uri = 10;</code> 303 * 304 * @return The bytes for redirectUri. 305 */ getRedirectUriBytes()306 com.google.protobuf.ByteString getRedirectUriBytes(); 307 308 /** 309 * 310 * 311 * <pre> 312 * The fully qualified resource name of applied 313 * [controls](https://cloud.google.com/retail/docs/serving-control-rules). 314 * </pre> 315 * 316 * <code>repeated string applied_controls = 12;</code> 317 * 318 * @return A list containing the appliedControls. 319 */ getAppliedControlsList()320 java.util.List<java.lang.String> getAppliedControlsList(); 321 /** 322 * 323 * 324 * <pre> 325 * The fully qualified resource name of applied 326 * [controls](https://cloud.google.com/retail/docs/serving-control-rules). 327 * </pre> 328 * 329 * <code>repeated string applied_controls = 12;</code> 330 * 331 * @return The count of appliedControls. 332 */ getAppliedControlsCount()333 int getAppliedControlsCount(); 334 /** 335 * 336 * 337 * <pre> 338 * The fully qualified resource name of applied 339 * [controls](https://cloud.google.com/retail/docs/serving-control-rules). 340 * </pre> 341 * 342 * <code>repeated string applied_controls = 12;</code> 343 * 344 * @param index The index of the element to return. 345 * @return The appliedControls at the given index. 346 */ getAppliedControls(int index)347 java.lang.String getAppliedControls(int index); 348 /** 349 * 350 * 351 * <pre> 352 * The fully qualified resource name of applied 353 * [controls](https://cloud.google.com/retail/docs/serving-control-rules). 354 * </pre> 355 * 356 * <code>repeated string applied_controls = 12;</code> 357 * 358 * @param index The index of the value to return. 359 * @return The bytes of the appliedControls at the given index. 360 */ getAppliedControlsBytes(int index)361 com.google.protobuf.ByteString getAppliedControlsBytes(int index); 362 363 /** 364 * 365 * 366 * <pre> 367 * The invalid 368 * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] 369 * that are not applied during serving. 370 * </pre> 371 * 372 * <code> 373 * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14; 374 * </code> 375 */ 376 java.util.List<com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec> getInvalidConditionBoostSpecsList()377 getInvalidConditionBoostSpecsList(); 378 /** 379 * 380 * 381 * <pre> 382 * The invalid 383 * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] 384 * that are not applied during serving. 385 * </pre> 386 * 387 * <code> 388 * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14; 389 * </code> 390 */ 391 com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec getInvalidConditionBoostSpecs(int index)392 getInvalidConditionBoostSpecs(int index); 393 /** 394 * 395 * 396 * <pre> 397 * The invalid 398 * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] 399 * that are not applied during serving. 400 * </pre> 401 * 402 * <code> 403 * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14; 404 * </code> 405 */ getInvalidConditionBoostSpecsCount()406 int getInvalidConditionBoostSpecsCount(); 407 /** 408 * 409 * 410 * <pre> 411 * The invalid 412 * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] 413 * that are not applied during serving. 414 * </pre> 415 * 416 * <code> 417 * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14; 418 * </code> 419 */ 420 java.util.List< 421 ? extends com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> getInvalidConditionBoostSpecsOrBuilderList()422 getInvalidConditionBoostSpecsOrBuilderList(); 423 /** 424 * 425 * 426 * <pre> 427 * The invalid 428 * [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] 429 * that are not applied during serving. 430 * </pre> 431 * 432 * <code> 433 * repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14; 434 * </code> 435 */ 436 com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getInvalidConditionBoostSpecsOrBuilder(int index)437 getInvalidConditionBoostSpecsOrBuilder(int index); 438 439 /** 440 * 441 * 442 * <pre> 443 * Metadata related to A/B testing [Experiment][] associated with this 444 * response. Only exists when an experiment is triggered. 445 * </pre> 446 * 447 * <code>repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;</code> 448 */ getExperimentInfoList()449 java.util.List<com.google.cloud.retail.v2.ExperimentInfo> getExperimentInfoList(); 450 /** 451 * 452 * 453 * <pre> 454 * Metadata related to A/B testing [Experiment][] associated with this 455 * response. Only exists when an experiment is triggered. 456 * </pre> 457 * 458 * <code>repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;</code> 459 */ getExperimentInfo(int index)460 com.google.cloud.retail.v2.ExperimentInfo getExperimentInfo(int index); 461 /** 462 * 463 * 464 * <pre> 465 * Metadata related to A/B testing [Experiment][] associated with this 466 * response. Only exists when an experiment is triggered. 467 * </pre> 468 * 469 * <code>repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;</code> 470 */ getExperimentInfoCount()471 int getExperimentInfoCount(); 472 /** 473 * 474 * 475 * <pre> 476 * Metadata related to A/B testing [Experiment][] associated with this 477 * response. Only exists when an experiment is triggered. 478 * </pre> 479 * 480 * <code>repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;</code> 481 */ 482 java.util.List<? extends com.google.cloud.retail.v2.ExperimentInfoOrBuilder> getExperimentInfoOrBuilderList()483 getExperimentInfoOrBuilderList(); 484 /** 485 * 486 * 487 * <pre> 488 * Metadata related to A/B testing [Experiment][] associated with this 489 * response. Only exists when an experiment is triggered. 490 * </pre> 491 * 492 * <code>repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;</code> 493 */ getExperimentInfoOrBuilder(int index)494 com.google.cloud.retail.v2.ExperimentInfoOrBuilder getExperimentInfoOrBuilder(int index); 495 } 496