Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ParameterMetadata (0.2.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	`Sequence[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	`Sequence[google.cloud.dataflow_v1beta3.types.ParameterMetadata.CustomMetadataEntry]` Optional. Additional metadata for describing this parameter.

builtins.object > proto.message.Message > ParameterMetadata

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.