1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\DiscoveryEngine;
|
---|
19 |
|
---|
20 | class GoogleCloudDiscoveryengineV1SearchRequest extends \Google\Collection
|
---|
21 | {
|
---|
22 | protected $collection_key = 'facetSpecs';
|
---|
23 | protected $boostSpecType = GoogleCloudDiscoveryengineV1SearchRequestBoostSpec::class;
|
---|
24 | protected $boostSpecDataType = '';
|
---|
25 | /**
|
---|
26 | * @var string
|
---|
27 | */
|
---|
28 | public $branch;
|
---|
29 | /**
|
---|
30 | * @var string
|
---|
31 | */
|
---|
32 | public $canonicalFilter;
|
---|
33 | protected $contentSearchSpecType = GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec::class;
|
---|
34 | protected $contentSearchSpecDataType = '';
|
---|
35 | protected $dataStoreSpecsType = GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec::class;
|
---|
36 | protected $dataStoreSpecsDataType = 'array';
|
---|
37 | protected $facetSpecsType = GoogleCloudDiscoveryengineV1SearchRequestFacetSpec::class;
|
---|
38 | protected $facetSpecsDataType = 'array';
|
---|
39 | /**
|
---|
40 | * @var string
|
---|
41 | */
|
---|
42 | public $filter;
|
---|
43 | protected $imageQueryType = GoogleCloudDiscoveryengineV1SearchRequestImageQuery::class;
|
---|
44 | protected $imageQueryDataType = '';
|
---|
45 | /**
|
---|
46 | * @var string
|
---|
47 | */
|
---|
48 | public $languageCode;
|
---|
49 | /**
|
---|
50 | * @var int
|
---|
51 | */
|
---|
52 | public $offset;
|
---|
53 | /**
|
---|
54 | * @var int
|
---|
55 | */
|
---|
56 | public $oneBoxPageSize;
|
---|
57 | /**
|
---|
58 | * @var string
|
---|
59 | */
|
---|
60 | public $orderBy;
|
---|
61 | /**
|
---|
62 | * @var int
|
---|
63 | */
|
---|
64 | public $pageSize;
|
---|
65 | /**
|
---|
66 | * @var string
|
---|
67 | */
|
---|
68 | public $pageToken;
|
---|
69 | /**
|
---|
70 | * @var array[]
|
---|
71 | */
|
---|
72 | public $params;
|
---|
73 | /**
|
---|
74 | * @var string
|
---|
75 | */
|
---|
76 | public $query;
|
---|
77 | protected $queryExpansionSpecType = GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec::class;
|
---|
78 | protected $queryExpansionSpecDataType = '';
|
---|
79 | /**
|
---|
80 | * @var bool
|
---|
81 | */
|
---|
82 | public $safeSearch;
|
---|
83 | protected $searchAsYouTypeSpecType = GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec::class;
|
---|
84 | protected $searchAsYouTypeSpecDataType = '';
|
---|
85 | /**
|
---|
86 | * @var string
|
---|
87 | */
|
---|
88 | public $session;
|
---|
89 | protected $sessionSpecType = GoogleCloudDiscoveryengineV1SearchRequestSessionSpec::class;
|
---|
90 | protected $sessionSpecDataType = '';
|
---|
91 | protected $spellCorrectionSpecType = GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec::class;
|
---|
92 | protected $spellCorrectionSpecDataType = '';
|
---|
93 | protected $userInfoType = GoogleCloudDiscoveryengineV1UserInfo::class;
|
---|
94 | protected $userInfoDataType = '';
|
---|
95 | /**
|
---|
96 | * @var string[]
|
---|
97 | */
|
---|
98 | public $userLabels;
|
---|
99 | /**
|
---|
100 | * @var string
|
---|
101 | */
|
---|
102 | public $userPseudoId;
|
---|
103 |
|
---|
104 | /**
|
---|
105 | * @param GoogleCloudDiscoveryengineV1SearchRequestBoostSpec
|
---|
106 | */
|
---|
107 | public function setBoostSpec(GoogleCloudDiscoveryengineV1SearchRequestBoostSpec $boostSpec)
|
---|
108 | {
|
---|
109 | $this->boostSpec = $boostSpec;
|
---|
110 | }
|
---|
111 | /**
|
---|
112 | * @return GoogleCloudDiscoveryengineV1SearchRequestBoostSpec
|
---|
113 | */
|
---|
114 | public function getBoostSpec()
|
---|
115 | {
|
---|
116 | return $this->boostSpec;
|
---|
117 | }
|
---|
118 | /**
|
---|
119 | * @param string
|
---|
120 | */
|
---|
121 | public function setBranch($branch)
|
---|
122 | {
|
---|
123 | $this->branch = $branch;
|
---|
124 | }
|
---|
125 | /**
|
---|
126 | * @return string
|
---|
127 | */
|
---|
128 | public function getBranch()
|
---|
129 | {
|
---|
130 | return $this->branch;
|
---|
131 | }
|
---|
132 | /**
|
---|
133 | * @param string
|
---|
134 | */
|
---|
135 | public function setCanonicalFilter($canonicalFilter)
|
---|
136 | {
|
---|
137 | $this->canonicalFilter = $canonicalFilter;
|
---|
138 | }
|
---|
139 | /**
|
---|
140 | * @return string
|
---|
141 | */
|
---|
142 | public function getCanonicalFilter()
|
---|
143 | {
|
---|
144 | return $this->canonicalFilter;
|
---|
145 | }
|
---|
146 | /**
|
---|
147 | * @param GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec
|
---|
148 | */
|
---|
149 | public function setContentSearchSpec(GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec $contentSearchSpec)
|
---|
150 | {
|
---|
151 | $this->contentSearchSpec = $contentSearchSpec;
|
---|
152 | }
|
---|
153 | /**
|
---|
154 | * @return GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec
|
---|
155 | */
|
---|
156 | public function getContentSearchSpec()
|
---|
157 | {
|
---|
158 | return $this->contentSearchSpec;
|
---|
159 | }
|
---|
160 | /**
|
---|
161 | * @param GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]
|
---|
162 | */
|
---|
163 | public function setDataStoreSpecs($dataStoreSpecs)
|
---|
164 | {
|
---|
165 | $this->dataStoreSpecs = $dataStoreSpecs;
|
---|
166 | }
|
---|
167 | /**
|
---|
168 | * @return GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]
|
---|
169 | */
|
---|
170 | public function getDataStoreSpecs()
|
---|
171 | {
|
---|
172 | return $this->dataStoreSpecs;
|
---|
173 | }
|
---|
174 | /**
|
---|
175 | * @param GoogleCloudDiscoveryengineV1SearchRequestFacetSpec[]
|
---|
176 | */
|
---|
177 | public function setFacetSpecs($facetSpecs)
|
---|
178 | {
|
---|
179 | $this->facetSpecs = $facetSpecs;
|
---|
180 | }
|
---|
181 | /**
|
---|
182 | * @return GoogleCloudDiscoveryengineV1SearchRequestFacetSpec[]
|
---|
183 | */
|
---|
184 | public function getFacetSpecs()
|
---|
185 | {
|
---|
186 | return $this->facetSpecs;
|
---|
187 | }
|
---|
188 | /**
|
---|
189 | * @param string
|
---|
190 | */
|
---|
191 | public function setFilter($filter)
|
---|
192 | {
|
---|
193 | $this->filter = $filter;
|
---|
194 | }
|
---|
195 | /**
|
---|
196 | * @return string
|
---|
197 | */
|
---|
198 | public function getFilter()
|
---|
199 | {
|
---|
200 | return $this->filter;
|
---|
201 | }
|
---|
202 | /**
|
---|
203 | * @param GoogleCloudDiscoveryengineV1SearchRequestImageQuery
|
---|
204 | */
|
---|
205 | public function setImageQuery(GoogleCloudDiscoveryengineV1SearchRequestImageQuery $imageQuery)
|
---|
206 | {
|
---|
207 | $this->imageQuery = $imageQuery;
|
---|
208 | }
|
---|
209 | /**
|
---|
210 | * @return GoogleCloudDiscoveryengineV1SearchRequestImageQuery
|
---|
211 | */
|
---|
212 | public function getImageQuery()
|
---|
213 | {
|
---|
214 | return $this->imageQuery;
|
---|
215 | }
|
---|
216 | /**
|
---|
217 | * @param string
|
---|
218 | */
|
---|
219 | public function setLanguageCode($languageCode)
|
---|
220 | {
|
---|
221 | $this->languageCode = $languageCode;
|
---|
222 | }
|
---|
223 | /**
|
---|
224 | * @return string
|
---|
225 | */
|
---|
226 | public function getLanguageCode()
|
---|
227 | {
|
---|
228 | return $this->languageCode;
|
---|
229 | }
|
---|
230 | /**
|
---|
231 | * @param int
|
---|
232 | */
|
---|
233 | public function setOffset($offset)
|
---|
234 | {
|
---|
235 | $this->offset = $offset;
|
---|
236 | }
|
---|
237 | /**
|
---|
238 | * @return int
|
---|
239 | */
|
---|
240 | public function getOffset()
|
---|
241 | {
|
---|
242 | return $this->offset;
|
---|
243 | }
|
---|
244 | /**
|
---|
245 | * @param int
|
---|
246 | */
|
---|
247 | public function setOneBoxPageSize($oneBoxPageSize)
|
---|
248 | {
|
---|
249 | $this->oneBoxPageSize = $oneBoxPageSize;
|
---|
250 | }
|
---|
251 | /**
|
---|
252 | * @return int
|
---|
253 | */
|
---|
254 | public function getOneBoxPageSize()
|
---|
255 | {
|
---|
256 | return $this->oneBoxPageSize;
|
---|
257 | }
|
---|
258 | /**
|
---|
259 | * @param string
|
---|
260 | */
|
---|
261 | public function setOrderBy($orderBy)
|
---|
262 | {
|
---|
263 | $this->orderBy = $orderBy;
|
---|
264 | }
|
---|
265 | /**
|
---|
266 | * @return string
|
---|
267 | */
|
---|
268 | public function getOrderBy()
|
---|
269 | {
|
---|
270 | return $this->orderBy;
|
---|
271 | }
|
---|
272 | /**
|
---|
273 | * @param int
|
---|
274 | */
|
---|
275 | public function setPageSize($pageSize)
|
---|
276 | {
|
---|
277 | $this->pageSize = $pageSize;
|
---|
278 | }
|
---|
279 | /**
|
---|
280 | * @return int
|
---|
281 | */
|
---|
282 | public function getPageSize()
|
---|
283 | {
|
---|
284 | return $this->pageSize;
|
---|
285 | }
|
---|
286 | /**
|
---|
287 | * @param string
|
---|
288 | */
|
---|
289 | public function setPageToken($pageToken)
|
---|
290 | {
|
---|
291 | $this->pageToken = $pageToken;
|
---|
292 | }
|
---|
293 | /**
|
---|
294 | * @return string
|
---|
295 | */
|
---|
296 | public function getPageToken()
|
---|
297 | {
|
---|
298 | return $this->pageToken;
|
---|
299 | }
|
---|
300 | /**
|
---|
301 | * @param array[]
|
---|
302 | */
|
---|
303 | public function setParams($params)
|
---|
304 | {
|
---|
305 | $this->params = $params;
|
---|
306 | }
|
---|
307 | /**
|
---|
308 | * @return array[]
|
---|
309 | */
|
---|
310 | public function getParams()
|
---|
311 | {
|
---|
312 | return $this->params;
|
---|
313 | }
|
---|
314 | /**
|
---|
315 | * @param string
|
---|
316 | */
|
---|
317 | public function setQuery($query)
|
---|
318 | {
|
---|
319 | $this->query = $query;
|
---|
320 | }
|
---|
321 | /**
|
---|
322 | * @return string
|
---|
323 | */
|
---|
324 | public function getQuery()
|
---|
325 | {
|
---|
326 | return $this->query;
|
---|
327 | }
|
---|
328 | /**
|
---|
329 | * @param GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec
|
---|
330 | */
|
---|
331 | public function setQueryExpansionSpec(GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec $queryExpansionSpec)
|
---|
332 | {
|
---|
333 | $this->queryExpansionSpec = $queryExpansionSpec;
|
---|
334 | }
|
---|
335 | /**
|
---|
336 | * @return GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec
|
---|
337 | */
|
---|
338 | public function getQueryExpansionSpec()
|
---|
339 | {
|
---|
340 | return $this->queryExpansionSpec;
|
---|
341 | }
|
---|
342 | /**
|
---|
343 | * @param bool
|
---|
344 | */
|
---|
345 | public function setSafeSearch($safeSearch)
|
---|
346 | {
|
---|
347 | $this->safeSearch = $safeSearch;
|
---|
348 | }
|
---|
349 | /**
|
---|
350 | * @return bool
|
---|
351 | */
|
---|
352 | public function getSafeSearch()
|
---|
353 | {
|
---|
354 | return $this->safeSearch;
|
---|
355 | }
|
---|
356 | /**
|
---|
357 | * @param GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec
|
---|
358 | */
|
---|
359 | public function setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec $searchAsYouTypeSpec)
|
---|
360 | {
|
---|
361 | $this->searchAsYouTypeSpec = $searchAsYouTypeSpec;
|
---|
362 | }
|
---|
363 | /**
|
---|
364 | * @return GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec
|
---|
365 | */
|
---|
366 | public function getSearchAsYouTypeSpec()
|
---|
367 | {
|
---|
368 | return $this->searchAsYouTypeSpec;
|
---|
369 | }
|
---|
370 | /**
|
---|
371 | * @param string
|
---|
372 | */
|
---|
373 | public function setSession($session)
|
---|
374 | {
|
---|
375 | $this->session = $session;
|
---|
376 | }
|
---|
377 | /**
|
---|
378 | * @return string
|
---|
379 | */
|
---|
380 | public function getSession()
|
---|
381 | {
|
---|
382 | return $this->session;
|
---|
383 | }
|
---|
384 | /**
|
---|
385 | * @param GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
|
---|
386 | */
|
---|
387 | public function setSessionSpec(GoogleCloudDiscoveryengineV1SearchRequestSessionSpec $sessionSpec)
|
---|
388 | {
|
---|
389 | $this->sessionSpec = $sessionSpec;
|
---|
390 | }
|
---|
391 | /**
|
---|
392 | * @return GoogleCloudDiscoveryengineV1SearchRequestSessionSpec
|
---|
393 | */
|
---|
394 | public function getSessionSpec()
|
---|
395 | {
|
---|
396 | return $this->sessionSpec;
|
---|
397 | }
|
---|
398 | /**
|
---|
399 | * @param GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec
|
---|
400 | */
|
---|
401 | public function setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec $spellCorrectionSpec)
|
---|
402 | {
|
---|
403 | $this->spellCorrectionSpec = $spellCorrectionSpec;
|
---|
404 | }
|
---|
405 | /**
|
---|
406 | * @return GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec
|
---|
407 | */
|
---|
408 | public function getSpellCorrectionSpec()
|
---|
409 | {
|
---|
410 | return $this->spellCorrectionSpec;
|
---|
411 | }
|
---|
412 | /**
|
---|
413 | * @param GoogleCloudDiscoveryengineV1UserInfo
|
---|
414 | */
|
---|
415 | public function setUserInfo(GoogleCloudDiscoveryengineV1UserInfo $userInfo)
|
---|
416 | {
|
---|
417 | $this->userInfo = $userInfo;
|
---|
418 | }
|
---|
419 | /**
|
---|
420 | * @return GoogleCloudDiscoveryengineV1UserInfo
|
---|
421 | */
|
---|
422 | public function getUserInfo()
|
---|
423 | {
|
---|
424 | return $this->userInfo;
|
---|
425 | }
|
---|
426 | /**
|
---|
427 | * @param string[]
|
---|
428 | */
|
---|
429 | public function setUserLabels($userLabels)
|
---|
430 | {
|
---|
431 | $this->userLabels = $userLabels;
|
---|
432 | }
|
---|
433 | /**
|
---|
434 | * @return string[]
|
---|
435 | */
|
---|
436 | public function getUserLabels()
|
---|
437 | {
|
---|
438 | return $this->userLabels;
|
---|
439 | }
|
---|
440 | /**
|
---|
441 | * @param string
|
---|
442 | */
|
---|
443 | public function setUserPseudoId($userPseudoId)
|
---|
444 | {
|
---|
445 | $this->userPseudoId = $userPseudoId;
|
---|
446 | }
|
---|
447 | /**
|
---|
448 | * @return string
|
---|
449 | */
|
---|
450 | public function getUserPseudoId()
|
---|
451 | {
|
---|
452 | return $this->userPseudoId;
|
---|
453 | }
|
---|
454 | }
|
---|
455 |
|
---|
456 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
457 | class_alias(GoogleCloudDiscoveryengineV1SearchRequest::class, 'Google_Service_DiscoveryEngine_GoogleCloudDiscoveryengineV1SearchRequest');
|
---|