pulumi-gcp-kotlin/com.pulumi.gcp.diagflow.kotlin.outputs/CxPageFormParameter

CxPageFormParameter

data class CxPageFormParameter(val advancedSettings: CxPageFormParameterAdvancedSettings? = null, val defaultValue: String? = null, val displayName: String? = null, val entityType: String? = null, val fillBehavior: CxPageFormParameterFillBehavior? = null, val isList: Boolean? = null, val redact: Boolean? = null, val required: Boolean? = null)

Constructors

CxPageFormParameter

constructor(advancedSettings: CxPageFormParameterAdvancedSettings? = null, defaultValue: String? = null, displayName: String? = null, entityType: String? = null, fillBehavior: CxPageFormParameterFillBehavior? = null, isList: Boolean? = null, redact: Boolean? = null, required: Boolean? = null)

Types

Companion

object Companion

Properties

advancedSettings

val advancedSettings: CxPageFormParameterAdvancedSettings? = null

Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Structure is documented below.

defaultValue

val defaultValue: String? = null

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

displayName

val displayName: String? = null

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

entityType

val entityType: 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.

fillBehavior

val fillBehavior: CxPageFormParameterFillBehavior? = null

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

isList

val isList: Boolean? = null

Indicates whether the parameter represents a list of values.

redact

val redact: 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.

required

val required: 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.