forked from googleapis/java-retail
/
CompleteQueryRequestOrBuilder.java
291 lines (282 loc) · 8.62 KB
/
CompleteQueryRequestOrBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
/*
* Copyright 2020 Google LLC
*
* 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
*
* https://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.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/retail/v2/completion_service.proto
package com.google.cloud.retail.v2;
public interface CompleteQueryRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.CompleteQueryRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* Required. Catalog for which the completion is performed.
* Full resource name of catalog, such as
* `projects/*/locations/global/catalogs/default_catalog`.
* </pre>
*
* <code>
* string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
* </code>
*
* @return The catalog.
*/
java.lang.String getCatalog();
/**
*
*
* <pre>
* Required. Catalog for which the completion is performed.
* Full resource name of catalog, such as
* `projects/*/locations/global/catalogs/default_catalog`.
* </pre>
*
* <code>
* string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
* </code>
*
* @return The bytes for catalog.
*/
com.google.protobuf.ByteString getCatalogBytes();
/**
*
*
* <pre>
* Required. The query used to generate suggestions.
* The maximum number of allowed characters is 255.
* </pre>
*
* <code>string query = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The query.
*/
java.lang.String getQuery();
/**
*
*
* <pre>
* Required. The query used to generate suggestions.
* The maximum number of allowed characters is 255.
* </pre>
*
* <code>string query = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*
* @return The bytes for query.
*/
com.google.protobuf.ByteString getQueryBytes();
/**
*
*
* <pre>
* A unique identifier for tracking visitors. For example, this could be
* implemented with an HTTP cookie, which should be able to uniquely identify
* a visitor on a single device. This unique identifier should not change if
* the visitor logs in or out of the website.
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* </pre>
*
* <code>string visitor_id = 7;</code>
*
* @return The visitorId.
*/
java.lang.String getVisitorId();
/**
*
*
* <pre>
* A unique identifier for tracking visitors. For example, this could be
* implemented with an HTTP cookie, which should be able to uniquely identify
* a visitor on a single device. This unique identifier should not change if
* the visitor logs in or out of the website.
* The field must be a UTF-8 encoded string with a length limit of 128
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
* </pre>
*
* <code>string visitor_id = 7;</code>
*
* @return The bytes for visitorId.
*/
com.google.protobuf.ByteString getVisitorIdBytes();
/**
*
*
* <pre>
* The list of languages of the query. This is
* the BCP-47 language code, such as "en-US" or "sr-Latn".
* For more information, see
* [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
* The maximum number of allowed characters is 255.
* Only "en-US" is currently supported.
* </pre>
*
* <code>repeated string language_codes = 3;</code>
*
* @return A list containing the languageCodes.
*/
java.util.List<java.lang.String> getLanguageCodesList();
/**
*
*
* <pre>
* The list of languages of the query. This is
* the BCP-47 language code, such as "en-US" or "sr-Latn".
* For more information, see
* [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
* The maximum number of allowed characters is 255.
* Only "en-US" is currently supported.
* </pre>
*
* <code>repeated string language_codes = 3;</code>
*
* @return The count of languageCodes.
*/
int getLanguageCodesCount();
/**
*
*
* <pre>
* The list of languages of the query. This is
* the BCP-47 language code, such as "en-US" or "sr-Latn".
* For more information, see
* [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
* The maximum number of allowed characters is 255.
* Only "en-US" is currently supported.
* </pre>
*
* <code>repeated string language_codes = 3;</code>
*
* @param index The index of the element to return.
* @return The languageCodes at the given index.
*/
java.lang.String getLanguageCodes(int index);
/**
*
*
* <pre>
* The list of languages of the query. This is
* the BCP-47 language code, such as "en-US" or "sr-Latn".
* For more information, see
* [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
* The maximum number of allowed characters is 255.
* Only "en-US" is currently supported.
* </pre>
*
* <code>repeated string language_codes = 3;</code>
*
* @param index The index of the value to return.
* @return The bytes of the languageCodes at the given index.
*/
com.google.protobuf.ByteString getLanguageCodesBytes(int index);
/**
*
*
* <pre>
* The device type context for completion suggestions.
* It is useful to apply different suggestions on different device types, e.g.
* `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
* types.
* Supported formats:
* * `UNKNOWN_DEVICE_TYPE`
* * `DESKTOP`
* * `MOBILE`
* * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
* </pre>
*
* <code>string device_type = 4;</code>
*
* @return The deviceType.
*/
java.lang.String getDeviceType();
/**
*
*
* <pre>
* The device type context for completion suggestions.
* It is useful to apply different suggestions on different device types, e.g.
* `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
* types.
* Supported formats:
* * `UNKNOWN_DEVICE_TYPE`
* * `DESKTOP`
* * `MOBILE`
* * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
* </pre>
*
* <code>string device_type = 4;</code>
*
* @return The bytes for deviceType.
*/
com.google.protobuf.ByteString getDeviceTypeBytes();
/**
*
*
* <pre>
* Determines which dataset to use for fetching completion. "user-data" will
* use the imported dataset through
* [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
* "cloud-retail" will use the dataset generated by cloud retail based on user
* events. If leave empty, it will use the "user-data".
* Current supported values:
* * user-data
* * cloud-retail
* This option requires additional allowlisting. Before using cloud-retail,
* contact Cloud Retail support team first.
* </pre>
*
* <code>string dataset = 6;</code>
*
* @return The dataset.
*/
java.lang.String getDataset();
/**
*
*
* <pre>
* Determines which dataset to use for fetching completion. "user-data" will
* use the imported dataset through
* [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
* "cloud-retail" will use the dataset generated by cloud retail based on user
* events. If leave empty, it will use the "user-data".
* Current supported values:
* * user-data
* * cloud-retail
* This option requires additional allowlisting. Before using cloud-retail,
* contact Cloud Retail support team first.
* </pre>
*
* <code>string dataset = 6;</code>
*
* @return The bytes for dataset.
*/
com.google.protobuf.ByteString getDatasetBytes();
/**
*
*
* <pre>
* Completion max suggestions. If left unset or set to 0, then will fallback
* to the configured value [CompletionConfig.max_suggestions][].
* The maximum allowed max suggestions is 20. If it is set higher, it will be
* capped by 20.
* </pre>
*
* <code>int32 max_suggestions = 5;</code>
*
* @return The maxSuggestions.
*/
int getMaxSuggestions();
}