-
Notifications
You must be signed in to change notification settings - Fork 461
Expand file tree
/
Copy pathInstruction.php
More file actions
423 lines (382 loc) · 13.4 KB
/
Instruction.php
File metadata and controls
423 lines (382 loc) · 13.4 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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/cloud/datalabeling/v1beta1/instruction.proto
namespace Google\Cloud\DataLabeling\V1beta1;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;
/**
* Instruction of how to perform the labeling task for human operators.
* Currently only PDF instruction is supported.
*
* Generated from protobuf message <code>google.cloud.datalabeling.v1beta1.Instruction</code>
*/
class Instruction extends \Google\Protobuf\Internal\Message
{
/**
* Output only. Instruction resource name, format:
* projects/{project_id}/instructions/{instruction_id}
*
* Generated from protobuf field <code>string name = 1;</code>
*/
protected $name = '';
/**
* Required. The display name of the instruction. Maximum of 64 characters.
*
* Generated from protobuf field <code>string display_name = 2;</code>
*/
protected $display_name = '';
/**
* Optional. User-provided description of the instruction.
* The description can be up to 10000 characters long.
*
* Generated from protobuf field <code>string description = 3;</code>
*/
protected $description = '';
/**
* Output only. Creation time of instruction.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4;</code>
*/
protected $create_time = null;
/**
* Output only. Last update time of instruction.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 5;</code>
*/
protected $update_time = null;
/**
* Required. The data type of this instruction.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.DataType data_type = 6;</code>
*/
protected $data_type = 0;
/**
* Deprecated: this instruction format is not supported any more.
* Instruction from a CSV file, such as for classification task.
* The CSV file should have exact two columns, in the following format:
* * The first column is labeled data, such as an image reference, text.
* * The second column is comma separated labels associated with data.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];</code>
* @deprecated
*/
protected $csv_instruction = null;
/**
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;</code>
*/
protected $pdf_instruction = null;
/**
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
* Generated from protobuf field <code>repeated string blocking_resources = 10;</code>
*/
private $blocking_resources;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $name
* Output only. Instruction resource name, format:
* projects/{project_id}/instructions/{instruction_id}
* @type string $display_name
* Required. The display name of the instruction. Maximum of 64 characters.
* @type string $description
* Optional. User-provided description of the instruction.
* The description can be up to 10000 characters long.
* @type \Google\Protobuf\Timestamp $create_time
* Output only. Creation time of instruction.
* @type \Google\Protobuf\Timestamp $update_time
* Output only. Last update time of instruction.
* @type int $data_type
* Required. The data type of this instruction.
* @type \Google\Cloud\DataLabeling\V1beta1\CsvInstruction $csv_instruction
* Deprecated: this instruction format is not supported any more.
* Instruction from a CSV file, such as for classification task.
* The CSV file should have exact two columns, in the following format:
* * The first column is labeled data, such as an image reference, text.
* * The second column is comma separated labels associated with data.
* @type \Google\Cloud\DataLabeling\V1beta1\PdfInstruction $pdf_instruction
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
* @type string[] $blocking_resources
* Output only. The names of any related resources that are blocking changes
* to the instruction.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Datalabeling\V1Beta1\Instruction::initOnce();
parent::__construct($data);
}
/**
* Output only. Instruction resource name, format:
* projects/{project_id}/instructions/{instruction_id}
*
* Generated from protobuf field <code>string name = 1;</code>
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. Instruction resource name, format:
* projects/{project_id}/instructions/{instruction_id}
*
* Generated from protobuf field <code>string name = 1;</code>
* @param string $var
* @return $this
*/
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
}
/**
* Required. The display name of the instruction. Maximum of 64 characters.
*
* Generated from protobuf field <code>string display_name = 2;</code>
* @return string
*/
public function getDisplayName()
{
return $this->display_name;
}
/**
* Required. The display name of the instruction. Maximum of 64 characters.
*
* Generated from protobuf field <code>string display_name = 2;</code>
* @param string $var
* @return $this
*/
public function setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
}
/**
* Optional. User-provided description of the instruction.
* The description can be up to 10000 characters long.
*
* Generated from protobuf field <code>string description = 3;</code>
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Optional. User-provided description of the instruction.
* The description can be up to 10000 characters long.
*
* Generated from protobuf field <code>string description = 3;</code>
* @param string $var
* @return $this
*/
public function setDescription($var)
{
GPBUtil::checkString($var, True);
$this->description = $var;
return $this;
}
/**
* Output only. Creation time of instruction.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4;</code>
* @return \Google\Protobuf\Timestamp|null
*/
public function getCreateTime()
{
return $this->create_time;
}
public function hasCreateTime()
{
return isset($this->create_time);
}
public function clearCreateTime()
{
unset($this->create_time);
}
/**
* Output only. Creation time of instruction.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 4;</code>
* @param \Google\Protobuf\Timestamp $var
* @return $this
*/
public function setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
}
/**
* Output only. Last update time of instruction.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 5;</code>
* @return \Google\Protobuf\Timestamp|null
*/
public function getUpdateTime()
{
return $this->update_time;
}
public function hasUpdateTime()
{
return isset($this->update_time);
}
public function clearUpdateTime()
{
unset($this->update_time);
}
/**
* Output only. Last update time of instruction.
*
* Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 5;</code>
* @param \Google\Protobuf\Timestamp $var
* @return $this
*/
public function setUpdateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->update_time = $var;
return $this;
}
/**
* Required. The data type of this instruction.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.DataType data_type = 6;</code>
* @return int
*/
public function getDataType()
{
return $this->data_type;
}
/**
* Required. The data type of this instruction.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.DataType data_type = 6;</code>
* @param int $var
* @return $this
*/
public function setDataType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\DataLabeling\V1beta1\DataType::class);
$this->data_type = $var;
return $this;
}
/**
* Deprecated: this instruction format is not supported any more.
* Instruction from a CSV file, such as for classification task.
* The CSV file should have exact two columns, in the following format:
* * The first column is labeled data, such as an image reference, text.
* * The second column is comma separated labels associated with data.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];</code>
* @return \Google\Cloud\DataLabeling\V1beta1\CsvInstruction|null
* @deprecated
*/
public function getCsvInstruction()
{
if (isset($this->csv_instruction)) {
@trigger_error('csv_instruction is deprecated.', E_USER_DEPRECATED);
}
return $this->csv_instruction;
}
public function hasCsvInstruction()
{
if (isset($this->csv_instruction)) {
@trigger_error('csv_instruction is deprecated.', E_USER_DEPRECATED);
}
return isset($this->csv_instruction);
}
public function clearCsvInstruction()
{
@trigger_error('csv_instruction is deprecated.', E_USER_DEPRECATED);
unset($this->csv_instruction);
}
/**
* Deprecated: this instruction format is not supported any more.
* Instruction from a CSV file, such as for classification task.
* The CSV file should have exact two columns, in the following format:
* * The first column is labeled data, such as an image reference, text.
* * The second column is comma separated labels associated with data.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];</code>
* @param \Google\Cloud\DataLabeling\V1beta1\CsvInstruction $var
* @return $this
* @deprecated
*/
public function setCsvInstruction($var)
{
@trigger_error('csv_instruction is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkMessage($var, \Google\Cloud\DataLabeling\V1beta1\CsvInstruction::class);
$this->csv_instruction = $var;
return $this;
}
/**
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;</code>
* @return \Google\Cloud\DataLabeling\V1beta1\PdfInstruction|null
*/
public function getPdfInstruction()
{
return $this->pdf_instruction;
}
public function hasPdfInstruction()
{
return isset($this->pdf_instruction);
}
public function clearPdfInstruction()
{
unset($this->pdf_instruction);
}
/**
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
*
* Generated from protobuf field <code>.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;</code>
* @param \Google\Cloud\DataLabeling\V1beta1\PdfInstruction $var
* @return $this
*/
public function setPdfInstruction($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DataLabeling\V1beta1\PdfInstruction::class);
$this->pdf_instruction = $var;
return $this;
}
/**
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
* Generated from protobuf field <code>repeated string blocking_resources = 10;</code>
* @return RepeatedField<string>
*/
public function getBlockingResources()
{
return $this->blocking_resources;
}
/**
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
* Generated from protobuf field <code>repeated string blocking_resources = 10;</code>
* @param string[] $var
* @return $this
*/
public function setBlockingResources($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->blocking_resources = $arr;
return $this;
}
}