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
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__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. |
↳ group_name |
string
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. |
↳ parent_name |
string
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. |
↳ parent_trigger_values |
array
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). |
↳ enum_options |
array<ParameterMetadataEnumOption>
Optional. The options shown when ENUM ParameterType is specified. |
↳ default_value |
string
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. |
↳ hidden_ui |
bool
Optional. Whether the parameter should be hidden in the UI. |
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 |
|
getGroupName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGroupName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParentName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParentName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParentTriggerValues
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).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setParentTriggerValues
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).
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnumOptions
Optional. The options shown when ENUM ParameterType is specified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEnumOptions
Optional. The options shown when ENUM ParameterType is specified.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ParameterMetadataEnumOption>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultValue
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDefaultValue
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHiddenUi
Optional. Whether the parameter should be hidden in the UI.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setHiddenUi
Optional. Whether the parameter should be hidden in the UI.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|