Class ParameterMetadata

Metadata for a specific parameter.

Inheritance

object

ParameterMetadata

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dataflow.v1b3.Data

Assembly: Google.Apis.Dataflow.v1b3.dll

Syntax

public class ParameterMetadata : IDirectResponseSchema

Properties

CustomMetadata

Optional. Additional metadata for describing this parameter.

Declaration

[JsonProperty("customMetadata")]
public virtual IDictionary<string, string> CustomMetadata { get; set; }

Property Value

Type	Description
IDictionary<string, string>

DefaultValue

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.

Declaration

[JsonProperty("defaultValue")]
public virtual string DefaultValue { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnumOptions

Optional. The options shown when ENUM ParameterType is specified.

Declaration

[JsonProperty("enumOptions")]
public virtual IList<ParameterMetadataEnumOption> EnumOptions { get; set; }

Property Value

Type	Description
IList<ParameterMetadataEnumOption>

GroupName

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.

Declaration

[JsonProperty("groupName")]
public virtual string GroupName { get; set; }

Property Value

Type	Description
string

HelpText

Required. The help text to display for the parameter.

Declaration

[JsonProperty("helpText")]
public virtual string HelpText { get; set; }

Property Value

Type	Description
string

HiddenUi

Optional. Whether the parameter should be hidden in the UI.

Declaration

[JsonProperty("hiddenUi")]
public virtual bool? HiddenUi { get; set; }

Property Value

Type	Description
bool?

IsOptional

Optional. Whether the parameter is optional. Defaults to false.

Declaration

[JsonProperty("isOptional")]
public virtual bool? IsOptional { get; set; }

Property Value

Type	Description
bool?

Label

Required. The label to display for the parameter.

Declaration

[JsonProperty("label")]
public virtual string Label { get; set; }

Property Value

Type	Description
string

Name

Required. The name of the parameter.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ParamType

Optional. The type of the parameter. Used for selecting input picker.

Declaration

[JsonProperty("paramType")]
public virtual string ParamType { get; set; }

Property Value

Type	Description
string

ParentName

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.

Declaration

[JsonProperty("parentName")]
public virtual string ParentName { get; set; }

Property Value

Type	Description
string

ParentTriggerValues

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).

Declaration

[JsonProperty("parentTriggerValues")]
public virtual IList<string> ParentTriggerValues { get; set; }

Property Value

Type	Description
IList<string>

Regexes

Optional. Regexes that the parameter must match.

Declaration

[JsonProperty("regexes")]
public virtual IList<string> Regexes { get; set; }

Property Value

Type	Description
IList<string>

Implements

IDirectResponseSchema