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 \ FormMethods
__construct
Constructor.
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.
string
setDisplayName
Required. The human-readable name of the parameter, unique within the form.
var
string
$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.
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.
var
bool
$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.
string
setEntityType
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.
var
string
$this
getIsList
Indicates whether the parameter represents a list of values.
bool
setIsList
Indicates whether the parameter represents a list of values.
var
bool
$this
getFillBehavior
Required. Defines fill behavior for the parameter.
hasFillBehavior
clearFillBehavior
setFillBehavior
Required. Defines fill behavior for the parameter.
$this
getDefaultValue
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
hasDefaultValue
clearDefaultValue
setDefaultValue
The default value of an optional parameter. If the parameter is required, the default value will be ignored.
$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.
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.
var
bool
$this
getAdvancedSettings
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
hasAdvancedSettings
clearAdvancedSettings
setAdvancedSettings
Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
$this
