Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class ParameterMetadata.
Metadata for a specific parameter.
Generated from protobuf message google.dataflow.v1beta3.ParameterMetadata
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the parameter. |
↳ label |
string
Required. The label to display for the parameter. |
↳ help_text |
string
Required. The help text to display for the parameter. |
↳ is_optional |
bool
Optional. Whether the parameter is optional. Defaults to false. |
↳ regexes |
array
Optional. Regexes that the parameter must match. |
↳ param_type |
int
Optional. The type of the parameter. Used for selecting input picker. |
↳ custom_metadata |
array|Google\Protobuf\Internal\MapField
Optional. Additional metadata for describing this parameter. |
getName
Required. The name of the parameter.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The name of the parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabel
Required. The label to display for the parameter.
| Returns | |
|---|---|
| Type | Description |
string | |
setLabel
Required. The label to display for the parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHelpText
Required. The help text to display for the parameter.
| Returns | |
|---|---|
| Type | Description |
string | |
setHelpText
Required. The help text to display for the parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIsOptional
Optional. Whether the parameter is optional. Defaults to false.
| Returns | |
|---|---|
| Type | Description |
bool | |
setIsOptional
Optional. Whether the parameter is optional. Defaults to false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegexes
Optional. Regexes that the parameter must match.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRegexes
Optional. Regexes that the parameter must match.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParamType
Optional. The type of the parameter.
Used for selecting input picker.
| Returns | |
|---|---|
| Type | Description |
int | |
setParamType
Optional. The type of the parameter.
Used for selecting input picker.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomMetadata
Optional. Additional metadata for describing this parameter.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setCustomMetadata
Optional. Additional metadata for describing this parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |