public sealed class ParameterMetadata : IMessage<ParameterMetadata>, IEquatable<ParameterMetadata>, IDeepCloneable<ParameterMetadata>, IBufferMessage, IMessageReference documentation and code samples for the Dataflow v1beta3 API class ParameterMetadata.
Metadata for a specific parameter.
Implements
IMessageParameterMetadata, IEquatableParameterMetadata, IDeepCloneableParameterMetadata, IBufferMessage, IMessageNamespace
Google.Cloud.Dataflow.V1Beta3Assembly
Google.Cloud.Dataflow.V1Beta3.dll
Constructors
ParameterMetadata()
public ParameterMetadata()ParameterMetadata(ParameterMetadata)
public ParameterMetadata(ParameterMetadata other)| Parameter | |
|---|---|
| Name | Description |
other |
ParameterMetadata |
Properties
CustomMetadata
public MapField<string, string> CustomMetadata { get; }Optional. Additional metadata for describing this parameter.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
DefaultValue
public string DefaultValue { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnumOptions
public RepeatedField<ParameterMetadataEnumOption> EnumOptions { get; }Optional. The options shown when ENUM ParameterType is specified.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldParameterMetadataEnumOption |
|
GroupName
public string GroupName { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
HelpText
public string HelpText { get; set; }Required. The help text to display for the parameter.
| Property Value | |
|---|---|
| Type | Description |
string |
|
HiddenUi
public bool HiddenUi { get; set; }Optional. Whether the parameter should be hidden in the UI.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IsOptional
public bool IsOptional { get; set; }Optional. Whether the parameter is optional. Defaults to false.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Label
public string Label { get; set; }Required. The label to display for the parameter.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Name
public string Name { get; set; }Required. The name of the parameter.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParamType
public ParameterType ParamType { get; set; }Optional. The type of the parameter. Used for selecting input picker.
| Property Value | |
|---|---|
| Type | Description |
ParameterType |
|
ParentName
public string ParentName { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentTriggerValues
public RepeatedField<string> ParentTriggerValues { get; }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).
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
Regexes
public RepeatedField<string> Regexes { get; }Optional. Regexes that the parameter must match.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|