Google Cloud Dialogflow Cx V3 Client - Class Parameter (0.4.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Parameter.

Represents a form parameter.

Generated from protobuf message google.cloud.dialogflow.cx.v3.Form.Parameter

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3 \ Form

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ display_name`	`string` Required. The human-readable name of the parameter, unique within the form.
`↳ required`	`bool` 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.
`↳ entity_type`	`string` Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID>` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>` for developer entity types.
`↳ is_list`	`bool` Indicates whether the parameter represents a list of values.
`↳ fill_behavior`	`Google\Cloud\Dialogflow\Cx\V3\Form\Parameter\FillBehavior` Required. Defines fill behavior for the parameter.
`↳ default_value`	`Google\Protobuf\Value` The default value of an optional parameter. If the parameter is required, the default value will be ignored.
`↳ redact`	`bool` 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.
`↳ advanced_settings`	`Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings` Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

getDisplayName

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

Returns
Type	Description
`string`

setDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRequired

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.

Returns
Type	Description
`bool`

setRequired

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEntityType

Required. The entity type of the parameter.

Format: projects/-/locations/-/agents/-/entityTypes/<System Entity Type ID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID> for developer entity types.

Returns
Type	Description
`string`

setEntityType

Required. The entity type of the parameter.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIsList

Indicates whether the parameter represents a list of values.

Returns
Type	Description
`bool`

setIsList

Indicates whether the parameter represents a list of values.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getFillBehavior

Required. Defines fill behavior for the parameter.

Returns
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\Form\Parameter\FillBehavior\|null`

hasFillBehavior

clearFillBehavior

setFillBehavior

Required. Defines fill behavior for the parameter.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\Form\Parameter\FillBehavior`

Returns
Type	Description
`$this`

getDefaultValue

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

Returns
Type	Description
`Google\Protobuf\Value\|null`

hasDefaultValue

clearDefaultValue

setDefaultValue

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

Parameter
Name	Description
`var`	`Google\Protobuf\Value`

Returns
Type	Description
`$this`

getRedact

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.

Returns
Type	Description
`bool`

setRedact

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAdvancedSettings

Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns
Type	Description
`Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings\|null`

hasAdvancedSettings

clearAdvancedSettings

setAdvancedSettings

Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\Cx\V3\AdvancedSettings`

Returns
Type	Description
`$this`