ParameterMetadataResponse class

Metadata for a specific parameter.

Constructors

ParameterMetadataResponse({required Input<Map<String, String>> customMetadata, required Input<String> defaultValue, required Input<List<ParameterMetadataEnumOptionResponse>> enumOptions, required Input<String> groupName, required Input<String> helpText, required Input<bool> isOptional, required Input<String> label, required Input<String> name, required Input<String> paramType, required Input<String> parentName, required Input<List<String>> parentTriggerValues, required Input<List<String>> regexes})

Creates a new ParameterMetadataResponse. customMetadata Optional. Additional metadata for describing this parameter. 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. enumOptions Optional. The options shown when ENUM ParameterType is specified. 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. helpText The help text to display for the parameter. isOptional Optional. Whether the parameter is optional. Defaults to false. label The label to display for the parameter. name The name of the parameter. paramType Optional. The type of the parameter. Used for selecting input picker. 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. 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). regexes Optional. Regexes that the parameter must match.

const

ParameterMetadataResponse.fromMap(Map<String, dynamic> map)

factory

Properties

customMetadata → Input<Map<String, String>>

Optional. Additional metadata for describing this parameter.

final

defaultValue → Input<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.

final

enumOptions → Input<List<ParameterMetadataEnumOptionResponse>>

Optional. The options shown when ENUM ParameterType is specified.

final

groupName → Input<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.

final

hashCode → int

The hash code for this object.

no setter, inherited

helpText → Input<String>

The help text to display for the parameter.

final

isOptional → Input<bool>

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

final

label → Input<String>

The label to display for the parameter.

final

name → Input<String>

The name of the parameter.

final

paramType → Input<String>

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

final

parentName → Input<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.

final

parentTriggerValues → Input<List<String>>

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

final

regexes → Input<List<String>>

Optional. Regexes that the parameter must match.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited