Repository navigation
Expand file tree
/
Copy pathCompleteQueryRequest.php
More file actions
403 lines (376 loc) · 15.1 KB
/
Copy pathCompleteQueryRequest.php
File metadata and controls
403 lines (376 loc) · 15.1 KB
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/cloud/retail/v2/completion_service.proto
namespace Google\Cloud\Retail\V2;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
/**
* Auto-complete parameters.
*
* Generated from protobuf message <code>google.cloud.retail.v2.CompleteQueryRequest</code>
*/
class CompleteQueryRequest extends \Google\Protobuf\Internal\Message
{
/**
* Required. Catalog for which the completion is performed.
* Full resource name of catalog, such as
* `projects/*/locations/global/catalogs/default_catalog`.
*
* Generated from protobuf field <code>string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
*/
private $catalog = '';
/**
* Required. The query used to generate suggestions.
* The maximum number of allowed characters is 255.
*
* Generated from protobuf field <code>string query = 2 [(.google.api.field_behavior) = REQUIRED];</code>
*/
private $query = '';
/**
* 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.
*
* Generated from protobuf field <code>string visitor_id = 7;</code>
*/
private $visitor_id = '';
/**
* 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.
*
* Generated from protobuf field <code>repeated string language_codes = 3;</code>
*/
private $language_codes;
/**
* 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`.
*
* Generated from protobuf field <code>string device_type = 4;</code>
*/
private $device_type = '';
/**
* 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.
*
* Generated from protobuf field <code>string dataset = 6;</code>
*/
private $dataset = '';
/**
* 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.
*
* Generated from protobuf field <code>int32 max_suggestions = 5;</code>
*/
private $max_suggestions = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $catalog
* Required. Catalog for which the completion is performed.
* Full resource name of catalog, such as
* `projects/*/locations/global/catalogs/default_catalog`.
* @type string $query
* Required. The query used to generate suggestions.
* The maximum number of allowed characters is 255.
* @type string $visitor_id
* 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.
* @type string[]|\Google\Protobuf\Internal\RepeatedField $language_codes
* 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.
* @type string $device_type
* 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`.
* @type string $dataset
* 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.
* @type int $max_suggestions
* 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.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Retail\V2\CompletionService::initOnce();
parent::__construct($data);
}
/**
* Required. Catalog for which the completion is performed.
* Full resource name of catalog, such as
* `projects/*/locations/global/catalogs/default_catalog`.
*
* Generated from protobuf field <code>string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
* @return string
*/
public function getCatalog()
{
return $this->catalog;
}
/**
* Required. Catalog for which the completion is performed.
* Full resource name of catalog, such as
* `projects/*/locations/global/catalogs/default_catalog`.
*
* Generated from protobuf field <code>string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
* @param string $var
* @return $this
*/
public function setCatalog($var)
{
GPBUtil::checkString($var, True);
$this->catalog = $var;
return $this;
}
/**
* Required. The query used to generate suggestions.
* The maximum number of allowed characters is 255.
*
* Generated from protobuf field <code>string query = 2 [(.google.api.field_behavior) = REQUIRED];</code>
* @return string
*/
public function getQuery()
{
return $this->query;
}
/**
* Required. The query used to generate suggestions.
* The maximum number of allowed characters is 255.
*
* Generated from protobuf field <code>string query = 2 [(.google.api.field_behavior) = REQUIRED];</code>
* @param string $var
* @return $this
*/
public function setQuery($var)
{
GPBUtil::checkString($var, True);
$this->query = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>string visitor_id = 7;</code>
* @return string
*/
public function getVisitorId()
{
return $this->visitor_id;
}
/**
* 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.
*
* Generated from protobuf field <code>string visitor_id = 7;</code>
* @param string $var
* @return $this
*/
public function setVisitorId($var)
{
GPBUtil::checkString($var, True);
$this->visitor_id = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated string language_codes = 3;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getLanguageCodes()
{
return $this->language_codes;
}
/**
* 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.
*
* Generated from protobuf field <code>repeated string language_codes = 3;</code>
* @param string[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setLanguageCodes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->language_codes = $arr;
return $this;
}
/**
* 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`.
*
* Generated from protobuf field <code>string device_type = 4;</code>
* @return string
*/
public function getDeviceType()
{
return $this->device_type;
}
/**
* 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`.
*
* Generated from protobuf field <code>string device_type = 4;</code>
* @param string $var
* @return $this
*/
public function setDeviceType($var)
{
GPBUtil::checkString($var, True);
$this->device_type = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>string dataset = 6;</code>
* @return string
*/
public function getDataset()
{
return $this->dataset;
}
/**
* 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.
*
* Generated from protobuf field <code>string dataset = 6;</code>
* @param string $var
* @return $this
*/
public function setDataset($var)
{
GPBUtil::checkString($var, True);
$this->dataset = $var;
return $this;
}
/**
* 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.
*
* Generated from protobuf field <code>int32 max_suggestions = 5;</code>
* @return int
*/
public function getMaxSuggestions()
{
return $this->max_suggestions;
}
/**
* 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.
*
* Generated from protobuf field <code>int32 max_suggestions = 5;</code>
* @param int $var
* @return $this
*/
public function setMaxSuggestions($var)
{
GPBUtil::checkInt32($var);
$this->max_suggestions = $var;
return $this;
}
}