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/discoveryengine/v1beta/user_event.proto 18 19 package com.google.cloud.discoveryengine.v1beta; 20 21 public interface SearchInfoOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.discoveryengine.v1beta.SearchInfo) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The user's search query. 31 * See 32 * [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query] 33 * for definition. 34 * The value must be a UTF-8 encoded string with a length limit of 5,000 35 * characters. Otherwise, an INVALID_ARGUMENT error is returned. 36 * At least one of 37 * [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query] 38 * or 39 * [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category] 40 * is required for `search` events. Other event types should not set this 41 * field. Otherwise, an INVALID_ARGUMENT error is returned. 42 * </pre> 43 * 44 * <code>string search_query = 1;</code> 45 * 46 * @return The searchQuery. 47 */ getSearchQuery()48 java.lang.String getSearchQuery(); 49 /** 50 * 51 * 52 * <pre> 53 * The user's search query. 54 * See 55 * [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query] 56 * for definition. 57 * The value must be a UTF-8 encoded string with a length limit of 5,000 58 * characters. Otherwise, an INVALID_ARGUMENT error is returned. 59 * At least one of 60 * [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query] 61 * or 62 * [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category] 63 * is required for `search` events. Other event types should not set this 64 * field. Otherwise, an INVALID_ARGUMENT error is returned. 65 * </pre> 66 * 67 * <code>string search_query = 1;</code> 68 * 69 * @return The bytes for searchQuery. 70 */ getSearchQueryBytes()71 com.google.protobuf.ByteString getSearchQueryBytes(); 72 73 /** 74 * 75 * 76 * <pre> 77 * The order in which products are returned, if applicable. 78 * See 79 * [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by] 80 * for definition and syntax. 81 * The value must be a UTF-8 encoded string with a length limit of 1,000 82 * characters. Otherwise, an INVALID_ARGUMENT error is returned. 83 * This can only be set for `search` events. Other event types should not set 84 * this field. Otherwise, an INVALID_ARGUMENT error is returned. 85 * </pre> 86 * 87 * <code>string order_by = 2;</code> 88 * 89 * @return The orderBy. 90 */ getOrderBy()91 java.lang.String getOrderBy(); 92 /** 93 * 94 * 95 * <pre> 96 * The order in which products are returned, if applicable. 97 * See 98 * [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by] 99 * for definition and syntax. 100 * The value must be a UTF-8 encoded string with a length limit of 1,000 101 * characters. Otherwise, an INVALID_ARGUMENT error is returned. 102 * This can only be set for `search` events. Other event types should not set 103 * this field. Otherwise, an INVALID_ARGUMENT error is returned. 104 * </pre> 105 * 106 * <code>string order_by = 2;</code> 107 * 108 * @return The bytes for orderBy. 109 */ getOrderByBytes()110 com.google.protobuf.ByteString getOrderByBytes(); 111 112 /** 113 * 114 * 115 * <pre> 116 * An integer that specifies the current offset for pagination (the 0-indexed 117 * starting location, amongst the products deemed by the API as relevant). 118 * See 119 * [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset] 120 * for definition. 121 * If this field is negative, an INVALID_ARGUMENT is returned. 122 * This can only be set for `search` events. Other event types should not set 123 * this field. Otherwise, an INVALID_ARGUMENT error is returned. 124 * </pre> 125 * 126 * <code>optional int32 offset = 3;</code> 127 * 128 * @return Whether the offset field is set. 129 */ hasOffset()130 boolean hasOffset(); 131 /** 132 * 133 * 134 * <pre> 135 * An integer that specifies the current offset for pagination (the 0-indexed 136 * starting location, amongst the products deemed by the API as relevant). 137 * See 138 * [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset] 139 * for definition. 140 * If this field is negative, an INVALID_ARGUMENT is returned. 141 * This can only be set for `search` events. Other event types should not set 142 * this field. Otherwise, an INVALID_ARGUMENT error is returned. 143 * </pre> 144 * 145 * <code>optional int32 offset = 3;</code> 146 * 147 * @return The offset. 148 */ getOffset()149 int getOffset(); 150 } 151