CxPageFormParameterArgs

data class CxPageFormParameterArgs(val defaultValue: Output<String>? = null, val displayName: Output<String>? = null, val entityType: Output<String>? = null, val fillBehavior: Output<CxPageFormParameterFillBehaviorArgs>? = null, val isList: Output<Boolean>? = null, val redact: Output<Boolean>? = null, val required: Output<Boolean>? = null) : ConvertibleToJava<CxPageFormParameterArgs>

Constructors

Link copied to clipboard
constructor(defaultValue: Output<String>? = null, displayName: Output<String>? = null, entityType: Output<String>? = null, fillBehavior: Output<CxPageFormParameterFillBehaviorArgs>? = null, isList: Output<Boolean>? = null, redact: Output<Boolean>? = null, required: Output<Boolean>? = null)

Properties

Link copied to clipboard
val defaultValue: Output<String>? = null

The default value of an optional parameter. If the parameter is required, the default value will be ignored.

Link copied to clipboard
val displayName: Output<String>? = null

The human-readable name of the parameter, unique within the form.

Link copied to clipboard
val entityType: Output<String>? = null

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

Link copied to clipboard

Defines fill behavior for the parameter. Structure is documented below.

Link copied to clipboard
val isList: Output<Boolean>? = null

Indicates whether the parameter represents a list of values.

Link copied to clipboard
val redact: Output<Boolean>? = null

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

Link copied to clipboard
val required: Output<Boolean>? = null

Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Functions

Link copied to clipboard
open override fun toJava(): CxPageFormParameterArgs