ParameterMetadataResponse

data class ParameterMetadataResponse(val customMetadata: Map<String, String>, val groupName: String, val helpText: String, val isOptional: Boolean, val label: String, val name: String, val paramType: String, val parentName: String, val parentTriggerValues: List<String>, val regexes: List<String>)

Metadata for a specific parameter.

Constructors

Link copied to clipboard
fun ParameterMetadataResponse(customMetadata: Map<String, String>, groupName: String, helpText: String, isOptional: Boolean, label: String, name: String, paramType: String, parentName: String, parentTriggerValues: List<String>, regexes: List<String>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Optional. Additional metadata for describing this parameter.

Link copied to clipboard

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.

Link copied to clipboard

The help text to display for the parameter.

Link copied to clipboard

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

Link copied to clipboard

The label to display for the parameter.

Link copied to clipboard

The name of the parameter.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Optional. Regexes that the parameter must match.