Class ParameterMetadata (0.9.0) 

ParameterMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metadata for a specific parameter.

Attributes
Name Description
name str
Required. The name of the parameter.
label str
Required. The label to display for the parameter.
help_text str
Required. The help text to display for the parameter.
is_optional bool
Optional. Whether the parameter is optional. Defaults to false.
regexes MutableSequence[str]
Optional. Regexes that the parameter must match.
param_type google.cloud.dataflow_v1beta3.types.ParameterType
Optional. The type of the parameter. Used for selecting input picker.
custom_metadata MutableMapping[str, str]
Optional. Additional metadata for describing this parameter.
group_name str
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 str
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 MutableSequence[str]
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 MutableSequence[google.cloud.dataflow_v1beta3.types.ParameterMetadataEnumOption]
Optional. The options shown when ENUM ParameterType is specified.
default_value str
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.

Classes

CustomMetadataEntry

CustomMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.