Repository navigation
Expand file tree
/
Copy pathCustomAttribute.php
More file actions
290 lines (268 loc) · 11.8 KB
/
Copy pathCustomAttribute.php
File metadata and controls
290 lines (268 loc) · 11.8 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
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/cloud/retail/v2/common.proto
namespace Google\Cloud\Retail\V2;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
/**
* A custom attribute that is not explicitly modeled in
* [Product][google.cloud.retail.v2.Product].
*
* Generated from protobuf message <code>google.cloud.retail.v2.CustomAttribute</code>
*/
class CustomAttribute extends \Google\Protobuf\Internal\Message
{
/**
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
* At most 400 values are allowed. Empty values are not allowed. Each value
* must be a UTF-8 encoded string with a length limit of 256 characters.
* Otherwise, an INVALID_ARGUMENT error is returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>repeated string text = 1;</code>
*/
private $text;
/**
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
* At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
* returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>repeated double numbers = 2;</code>
*/
private $numbers;
/**
* If true, custom attribute values are searchable by text queries in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* Only set if type [text][google.cloud.retail.v2.CustomAttribute.text] is
* set. Otherwise, a INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>optional bool searchable = 3;</code>
*/
private $searchable = null;
/**
* If true, custom attribute values are indexed, so that it can be filtered,
* faceted or boosted in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter],
* [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
* and
* [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
* for more details.
*
* Generated from protobuf field <code>optional bool indexable = 4;</code>
*/
private $indexable = null;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string[]|\Google\Protobuf\Internal\RepeatedField $text
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
* At most 400 values are allowed. Empty values are not allowed. Each value
* must be a UTF-8 encoded string with a length limit of 256 characters.
* Otherwise, an INVALID_ARGUMENT error is returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
* @type float[]|\Google\Protobuf\Internal\RepeatedField $numbers
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
* At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
* returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
* @type bool $searchable
* If true, custom attribute values are searchable by text queries in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* Only set if type [text][google.cloud.retail.v2.CustomAttribute.text] is
* set. Otherwise, a INVALID_ARGUMENT error is returned.
* @type bool $indexable
* If true, custom attribute values are indexed, so that it can be filtered,
* faceted or boosted in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter],
* [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
* and
* [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
* for more details.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Retail\V2\Common::initOnce();
parent::__construct($data);
}
/**
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
* At most 400 values are allowed. Empty values are not allowed. Each value
* must be a UTF-8 encoded string with a length limit of 256 characters.
* Otherwise, an INVALID_ARGUMENT error is returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>repeated string text = 1;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getText()
{
return $this->text;
}
/**
* The textual values of this custom attribute. For example, `["yellow",
* "green"]` when the key is "color".
* At most 400 values are allowed. Empty values are not allowed. Each value
* must be a UTF-8 encoded string with a length limit of 256 characters.
* Otherwise, an INVALID_ARGUMENT error is returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>repeated string text = 1;</code>
* @param string[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setText($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->text = $arr;
return $this;
}
/**
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
* At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
* returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>repeated double numbers = 2;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getNumbers()
{
return $this->numbers;
}
/**
* The numerical values of this custom attribute. For example, `[2.3, 15.4]`
* when the key is "lengths_cm".
* At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
* returned.
* Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or
* [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set.
* Otherwise, an INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>repeated double numbers = 2;</code>
* @param float[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setNumbers($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::DOUBLE);
$this->numbers = $arr;
return $this;
}
/**
* If true, custom attribute values are searchable by text queries in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* Only set if type [text][google.cloud.retail.v2.CustomAttribute.text] is
* set. Otherwise, a INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>optional bool searchable = 3;</code>
* @return bool
*/
public function getSearchable()
{
return isset($this->searchable) ? $this->searchable : false;
}
public function hasSearchable()
{
return isset($this->searchable);
}
public function clearSearchable()
{
unset($this->searchable);
}
/**
* If true, custom attribute values are searchable by text queries in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* Only set if type [text][google.cloud.retail.v2.CustomAttribute.text] is
* set. Otherwise, a INVALID_ARGUMENT error is returned.
*
* Generated from protobuf field <code>optional bool searchable = 3;</code>
* @param bool $var
* @return $this
*/
public function setSearchable($var)
{
GPBUtil::checkBool($var);
$this->searchable = $var;
return $this;
}
/**
* If true, custom attribute values are indexed, so that it can be filtered,
* faceted or boosted in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter],
* [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
* and
* [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
* for more details.
*
* Generated from protobuf field <code>optional bool indexable = 4;</code>
* @return bool
*/
public function getIndexable()
{
return isset($this->indexable) ? $this->indexable : false;
}
public function hasIndexable()
{
return isset($this->indexable);
}
public function clearIndexable()
{
unset($this->indexable);
}
/**
* If true, custom attribute values are indexed, so that it can be filtered,
* faceted or boosted in
* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].
* This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].
* See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter],
* [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs]
* and
* [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
* for more details.
*
* Generated from protobuf field <code>optional bool indexable = 4;</code>
* @param bool $var
* @return $this
*/
public function setIndexable($var)
{
GPBUtil::checkBool($var);
$this->indexable = $var;
return $this;
}
}