-
Notifications
You must be signed in to change notification settings - Fork 460
Expand file tree
/
Copy pathParameterMetadata.php
More file actions
523 lines (478 loc) · 16.7 KB
/
ParameterMetadata.php
File metadata and controls
523 lines (478 loc) · 16.7 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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/dataflow/v1beta3/templates.proto
namespace Google\Cloud\Dataflow\V1beta3;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;
/**
* Metadata for a specific parameter.
*
* Generated from protobuf message <code>google.dataflow.v1beta3.ParameterMetadata</code>
*/
class ParameterMetadata extends \Google\Protobuf\Internal\Message
{
/**
* Required. The name of the parameter.
*
* Generated from protobuf field <code>string name = 1;</code>
*/
protected $name = '';
/**
* Required. The label to display for the parameter.
*
* Generated from protobuf field <code>string label = 2;</code>
*/
protected $label = '';
/**
* Required. The help text to display for the parameter.
*
* Generated from protobuf field <code>string help_text = 3;</code>
*/
protected $help_text = '';
/**
* Optional. Whether the parameter is optional. Defaults to false.
*
* Generated from protobuf field <code>bool is_optional = 4;</code>
*/
protected $is_optional = false;
/**
* Optional. Regexes that the parameter must match.
*
* Generated from protobuf field <code>repeated string regexes = 5;</code>
*/
private $regexes;
/**
* Optional. The type of the parameter.
* Used for selecting input picker.
*
* Generated from protobuf field <code>.google.dataflow.v1beta3.ParameterType param_type = 6;</code>
*/
protected $param_type = 0;
/**
* Optional. Additional metadata for describing this parameter.
*
* Generated from protobuf field <code>map<string, string> custom_metadata = 7;</code>
*/
private $custom_metadata;
/**
* Optional. Specifies a group name for this parameter to be rendered under.
* Group header text will be rendered exactly as specified in this field. Only
* considered when parent_name is NOT provided.
*
* Generated from protobuf field <code>string group_name = 8;</code>
*/
protected $group_name = '';
/**
* Optional. Specifies the name of the parent parameter. Used in conjunction
* with 'parent_trigger_values' to make this parameter conditional (will only
* be rendered conditionally). Should be mappable to a ParameterMetadata.name
* field.
*
* Generated from protobuf field <code>string parent_name = 9;</code>
*/
protected $parent_name = '';
/**
* Optional. The value(s) of the 'parent_name' parameter which will trigger
* this parameter to be shown. If left empty, ANY non-empty value in
* parent_name will trigger this parameter to be shown. Only considered when
* this parameter is conditional (when 'parent_name' has been provided).
*
* Generated from protobuf field <code>repeated string parent_trigger_values = 10;</code>
*/
private $parent_trigger_values;
/**
* Optional. The options shown when ENUM ParameterType is specified.
*
* Generated from protobuf field <code>repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;</code>
*/
private $enum_options;
/**
* Optional. The default values will pre-populate the parameter with the
* given value from the proto. If default_value is left empty, the parameter
* will be populated with a default of the relevant type, e.g. false for a
* boolean.
*
* Generated from protobuf field <code>string default_value = 12;</code>
*/
protected $default_value = '';
/**
* Optional. Whether the parameter should be hidden in the UI.
*
* Generated from protobuf field <code>bool hidden_ui = 13;</code>
*/
protected $hidden_ui = false;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $name
* Required. The name of the parameter.
* @type string $label
* Required. The label to display for the parameter.
* @type string $help_text
* Required. The help text to display for the parameter.
* @type bool $is_optional
* Optional. Whether the parameter is optional. Defaults to false.
* @type string[] $regexes
* Optional. Regexes that the parameter must match.
* @type int $param_type
* Optional. The type of the parameter.
* Used for selecting input picker.
* @type array|\Google\Protobuf\Internal\MapField $custom_metadata
* Optional. Additional metadata for describing this parameter.
* @type string $group_name
* Optional. Specifies a group name for this parameter to be rendered under.
* Group header text will be rendered exactly as specified in this field. Only
* considered when parent_name is NOT provided.
* @type string $parent_name
* Optional. Specifies the name of the parent parameter. Used in conjunction
* with 'parent_trigger_values' to make this parameter conditional (will only
* be rendered conditionally). Should be mappable to a ParameterMetadata.name
* field.
* @type string[] $parent_trigger_values
* Optional. The value(s) of the 'parent_name' parameter which will trigger
* this parameter to be shown. If left empty, ANY non-empty value in
* parent_name will trigger this parameter to be shown. Only considered when
* this parameter is conditional (when 'parent_name' has been provided).
* @type \Google\Cloud\Dataflow\V1beta3\ParameterMetadataEnumOption[] $enum_options
* Optional. The options shown when ENUM ParameterType is specified.
* @type string $default_value
* Optional. The default values will pre-populate the parameter with the
* given value from the proto. If default_value is left empty, the parameter
* will be populated with a default of the relevant type, e.g. false for a
* boolean.
* @type bool $hidden_ui
* Optional. Whether the parameter should be hidden in the UI.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Dataflow\V1Beta3\Templates::initOnce();
parent::__construct($data);
}
/**
* Required. The name of the parameter.
*
* Generated from protobuf field <code>string name = 1;</code>
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Required. The name of the parameter.
*
* 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 label to display for the parameter.
*
* Generated from protobuf field <code>string label = 2;</code>
* @return string
*/
public function getLabel()
{
return $this->label;
}
/**
* Required. The label to display for the parameter.
*
* Generated from protobuf field <code>string label = 2;</code>
* @param string $var
* @return $this
*/
public function setLabel($var)
{
GPBUtil::checkString($var, True);
$this->label = $var;
return $this;
}
/**
* Required. The help text to display for the parameter.
*
* Generated from protobuf field <code>string help_text = 3;</code>
* @return string
*/
public function getHelpText()
{
return $this->help_text;
}
/**
* Required. The help text to display for the parameter.
*
* Generated from protobuf field <code>string help_text = 3;</code>
* @param string $var
* @return $this
*/
public function setHelpText($var)
{
GPBUtil::checkString($var, True);
$this->help_text = $var;
return $this;
}
/**
* Optional. Whether the parameter is optional. Defaults to false.
*
* Generated from protobuf field <code>bool is_optional = 4;</code>
* @return bool
*/
public function getIsOptional()
{
return $this->is_optional;
}
/**
* Optional. Whether the parameter is optional. Defaults to false.
*
* Generated from protobuf field <code>bool is_optional = 4;</code>
* @param bool $var
* @return $this
*/
public function setIsOptional($var)
{
GPBUtil::checkBool($var);
$this->is_optional = $var;
return $this;
}
/**
* Optional. Regexes that the parameter must match.
*
* Generated from protobuf field <code>repeated string regexes = 5;</code>
* @return RepeatedField<string>
*/
public function getRegexes()
{
return $this->regexes;
}
/**
* Optional. Regexes that the parameter must match.
*
* Generated from protobuf field <code>repeated string regexes = 5;</code>
* @param string[] $var
* @return $this
*/
public function setRegexes($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->regexes = $arr;
return $this;
}
/**
* Optional. The type of the parameter.
* Used for selecting input picker.
*
* Generated from protobuf field <code>.google.dataflow.v1beta3.ParameterType param_type = 6;</code>
* @return int
*/
public function getParamType()
{
return $this->param_type;
}
/**
* Optional. The type of the parameter.
* Used for selecting input picker.
*
* Generated from protobuf field <code>.google.dataflow.v1beta3.ParameterType param_type = 6;</code>
* @param int $var
* @return $this
*/
public function setParamType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dataflow\V1beta3\ParameterType::class);
$this->param_type = $var;
return $this;
}
/**
* Optional. Additional metadata for describing this parameter.
*
* Generated from protobuf field <code>map<string, string> custom_metadata = 7;</code>
* @return \Google\Protobuf\Internal\MapField
*/
public function getCustomMetadata()
{
return $this->custom_metadata;
}
/**
* Optional. Additional metadata for describing this parameter.
*
* Generated from protobuf field <code>map<string, string> custom_metadata = 7;</code>
* @param array|\Google\Protobuf\Internal\MapField $var
* @return $this
*/
public function setCustomMetadata($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->custom_metadata = $arr;
return $this;
}
/**
* Optional. Specifies a group name for this parameter to be rendered under.
* Group header text will be rendered exactly as specified in this field. Only
* considered when parent_name is NOT provided.
*
* Generated from protobuf field <code>string group_name = 8;</code>
* @return string
*/
public function getGroupName()
{
return $this->group_name;
}
/**
* Optional. Specifies a group name for this parameter to be rendered under.
* Group header text will be rendered exactly as specified in this field. Only
* considered when parent_name is NOT provided.
*
* Generated from protobuf field <code>string group_name = 8;</code>
* @param string $var
* @return $this
*/
public function setGroupName($var)
{
GPBUtil::checkString($var, True);
$this->group_name = $var;
return $this;
}
/**
* Optional. Specifies the name of the parent parameter. Used in conjunction
* with 'parent_trigger_values' to make this parameter conditional (will only
* be rendered conditionally). Should be mappable to a ParameterMetadata.name
* field.
*
* Generated from protobuf field <code>string parent_name = 9;</code>
* @return string
*/
public function getParentName()
{
return $this->parent_name;
}
/**
* Optional. Specifies the name of the parent parameter. Used in conjunction
* with 'parent_trigger_values' to make this parameter conditional (will only
* be rendered conditionally). Should be mappable to a ParameterMetadata.name
* field.
*
* Generated from protobuf field <code>string parent_name = 9;</code>
* @param string $var
* @return $this
*/
public function setParentName($var)
{
GPBUtil::checkString($var, True);
$this->parent_name = $var;
return $this;
}
/**
* Optional. The value(s) of the 'parent_name' parameter which will trigger
* this parameter to be shown. If left empty, ANY non-empty value in
* parent_name will trigger this parameter to be shown. Only considered when
* this parameter is conditional (when 'parent_name' has been provided).
*
* Generated from protobuf field <code>repeated string parent_trigger_values = 10;</code>
* @return RepeatedField<string>
*/
public function getParentTriggerValues()
{
return $this->parent_trigger_values;
}
/**
* Optional. The value(s) of the 'parent_name' parameter which will trigger
* this parameter to be shown. If left empty, ANY non-empty value in
* parent_name will trigger this parameter to be shown. Only considered when
* this parameter is conditional (when 'parent_name' has been provided).
*
* Generated from protobuf field <code>repeated string parent_trigger_values = 10;</code>
* @param string[] $var
* @return $this
*/
public function setParentTriggerValues($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->parent_trigger_values = $arr;
return $this;
}
/**
* Optional. The options shown when ENUM ParameterType is specified.
*
* Generated from protobuf field <code>repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;</code>
* @return RepeatedField<\Google\Cloud\Dataflow\V1beta3\ParameterMetadataEnumOption>
*/
public function getEnumOptions()
{
return $this->enum_options;
}
/**
* Optional. The options shown when ENUM ParameterType is specified.
*
* Generated from protobuf field <code>repeated .google.dataflow.v1beta3.ParameterMetadataEnumOption enum_options = 11;</code>
* @param \Google\Cloud\Dataflow\V1beta3\ParameterMetadataEnumOption[] $var
* @return $this
*/
public function setEnumOptions($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dataflow\V1beta3\ParameterMetadataEnumOption::class);
$this->enum_options = $arr;
return $this;
}
/**
* Optional. The default values will pre-populate the parameter with the
* given value from the proto. If default_value is left empty, the parameter
* will be populated with a default of the relevant type, e.g. false for a
* boolean.
*
* Generated from protobuf field <code>string default_value = 12;</code>
* @return string
*/
public function getDefaultValue()
{
return $this->default_value;
}
/**
* Optional. The default values will pre-populate the parameter with the
* given value from the proto. If default_value is left empty, the parameter
* will be populated with a default of the relevant type, e.g. false for a
* boolean.
*
* Generated from protobuf field <code>string default_value = 12;</code>
* @param string $var
* @return $this
*/
public function setDefaultValue($var)
{
GPBUtil::checkString($var, True);
$this->default_value = $var;
return $this;
}
/**
* Optional. Whether the parameter should be hidden in the UI.
*
* Generated from protobuf field <code>bool hidden_ui = 13;</code>
* @return bool
*/
public function getHiddenUi()
{
return $this->hidden_ui;
}
/**
* Optional. Whether the parameter should be hidden in the UI.
*
* Generated from protobuf field <code>bool hidden_ui = 13;</code>
* @param bool $var
* @return $this
*/
public function setHiddenUi($var)
{
GPBUtil::checkBool($var);
$this->hidden_ui = $var;
return $this;
}
}