cli/foundry.cli.buildkite/FieldElement

FieldElement

@Serializable

data class FieldElement(val default: SimpleStringValue? = null, val hint: String? = null, val key: String, val required: Boolean? = null, val text: String? = null, val multiple: Boolean? = null, val options: List<Option>? = null, val select: String? = null)(source)

A list of input fields required to be filled out before unblocking the step

Constructors

constructor(default: SimpleStringValue? = null, hint: String? = null, key: String, required: Boolean? = null, text: String? = null, multiple: Boolean? = null, options: List<Option>? = null, select: String? = null)

Properties

val default: SimpleStringValue? = null

The value that is pre-filled in the text field

val hint: String? = null

The explanatory text that is shown after the label

val key: String

The meta-data key that stores the field's input

val multiple: Boolean? = null

Whether more than one option may be selected

val options: List<Option>? = null

val required: Boolean? = null

Whether the field is required for form submission

val select: String? = null

The text input name

val text: String? = null

The text input name