Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class Parameter.
Represents intent parameters.
Generated from protobuf messagegoogle.cloud.dialogflow.v2.Intent.Parameter
Namespace
Google \ Cloud \ Dialogflow \ V2 \ Intent
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of this parameter.
↳ display_name
string
Required. The name of the parameter.
↳ value
string
Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as$parameter_name, - an original parameter value defined as$parameter_name.original, - a parameter value from some context defined as#context_name.parameter_name.
↳ default_value
string
Optional. The default value to use when thevalueyields an empty result. Default values can be extracted from contexts by using the following syntax:#context_name.parameter_name.
↳ entity_type_display_name
string
Optional. The name of the entity type, prefixed with@, that describes values of the parameter. If the parameter is required, this must be provided.
↳ mandatory
bool
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
↳ prompts
array
Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
↳ is_list
bool
Optional. Indicates whether the parameter represents a list of values.
getName
The unique identifier of this parameter.
Returns
Type
Description
string
setName
The unique identifier of this parameter.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Required. The name of the parameter.
Returns
Type
Description
string
setDisplayName
Required. The name of the parameter.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValue
Optional. The definition of the parameter value. It can be:
a constant string,
a parameter value defined as$parameter_name,
an original parameter value defined as$parameter_name.original,
a parameter value from some context defined as#context_name.parameter_name.
Returns
Type
Description
string
setValue
Optional. The definition of the parameter value. It can be:
a constant string,
a parameter value defined as$parameter_name,
an original parameter value defined as$parameter_name.original,
a parameter value from some context defined as#context_name.parameter_name.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDefaultValue
Optional. The default value to use when thevalueyields an empty
result.
Default values can be extracted from contexts by using the following
syntax:#context_name.parameter_name.
Returns
Type
Description
string
setDefaultValue
Optional. The default value to use when thevalueyields an empty
result.
Default values can be extracted from contexts by using the following
syntax:#context_name.parameter_name.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEntityTypeDisplayName
Optional. The name of the entity type, prefixed with@, that
describes values of the parameter. If the parameter is
required, this must be provided.
Returns
Type
Description
string
setEntityTypeDisplayName
Optional. The name of the entity type, prefixed with@, that
describes values of the parameter. If the parameter is
required, this must be provided.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMandatory
Optional. Indicates whether the parameter is required. That is,
whether the intent cannot be completed without collecting the parameter
value.
Returns
Type
Description
bool
setMandatory
Optional. Indicates whether the parameter is required. That is,
whether the intent cannot be completed without collecting the parameter
value.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getPrompts
Optional. The collection of prompts that the agent can present to the
user in order to collect a value for the parameter.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow V2 Client - Class Parameter (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-dialogflow/latest/V2.Intent.Parameter)\n- [2.1.1](/php/docs/reference/cloud-dialogflow/2.1.1/V2.Intent.Parameter)\n- [2.0.1](/php/docs/reference/cloud-dialogflow/2.0.1/V2.Intent.Parameter)\n- [1.17.2](/php/docs/reference/cloud-dialogflow/1.17.2/V2.Intent.Parameter)\n- [1.16.0](/php/docs/reference/cloud-dialogflow/1.16.0/V2.Intent.Parameter)\n- [1.15.1](/php/docs/reference/cloud-dialogflow/1.15.1/V2.Intent.Parameter)\n- [1.14.0](/php/docs/reference/cloud-dialogflow/1.14.0/V2.Intent.Parameter)\n- [1.13.0](/php/docs/reference/cloud-dialogflow/1.13.0/V2.Intent.Parameter)\n- [1.12.3](/php/docs/reference/cloud-dialogflow/1.12.3/V2.Intent.Parameter)\n- [1.11.0](/php/docs/reference/cloud-dialogflow/1.11.0/V2.Intent.Parameter)\n- [1.10.2](/php/docs/reference/cloud-dialogflow/1.10.2/V2.Intent.Parameter)\n- [1.9.0](/php/docs/reference/cloud-dialogflow/1.9.0/V2.Intent.Parameter)\n- [1.8.0](/php/docs/reference/cloud-dialogflow/1.8.0/V2.Intent.Parameter)\n- [1.7.2](/php/docs/reference/cloud-dialogflow/1.7.2/V2.Intent.Parameter)\n- [1.6.0](/php/docs/reference/cloud-dialogflow/1.6.0/V2.Intent.Parameter)\n- [1.5.0](/php/docs/reference/cloud-dialogflow/1.5.0/V2.Intent.Parameter)\n- [1.4.0](/php/docs/reference/cloud-dialogflow/1.4.0/V2.Intent.Parameter)\n- [1.3.2](/php/docs/reference/cloud-dialogflow/1.3.2/V2.Intent.Parameter)\n- [1.2.0](/php/docs/reference/cloud-dialogflow/1.2.0/V2.Intent.Parameter)\n- [1.1.1](/php/docs/reference/cloud-dialogflow/1.1.1/V2.Intent.Parameter)\n- [1.0.1](/php/docs/reference/cloud-dialogflow/1.0.1/V2.Intent.Parameter) \nReference documentation and code samples for the Google Cloud Dialogflow V2 Client class Parameter.\n\nRepresents intent parameters.\n\nGenerated from protobuf message `google.cloud.dialogflow.v2.Intent.Parameter`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ V2 \\\\ Intent\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique identifier of this parameter.\n\n### setName\n\nThe unique identifier of this parameter.\n\n### getDisplayName\n\nRequired. The name of the parameter.\n\n### setDisplayName\n\nRequired. The name of the parameter.\n\n### getValue\n\nOptional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as `#context_name.parameter_name`.\n\n### setValue\n\nOptional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as `#context_name.parameter_name`.\n\n### getDefaultValue\n\nOptional. The default value to use when the `value` yields an empty\nresult.\n\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.\n\n### setDefaultValue\n\nOptional. The default value to use when the `value` yields an empty\nresult.\n\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.\n\n### getEntityTypeDisplayName\n\nOptional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.\n\n### setEntityTypeDisplayName\n\nOptional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.\n\n### getMandatory\n\nOptional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.\n\n### setMandatory\n\nOptional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.\n\n### getPrompts\n\nOptional. The collection of prompts that the agent can present to the\nuser in order to collect a value for the parameter.\n\n### setPrompts\n\nOptional. The collection of prompts that the agent can present to the\nuser in order to collect a value for the parameter.\n\n### getIsList\n\nOptional. Indicates whether the parameter represents a list of values.\n\n### setIsList\n\nOptional. Indicates whether the parameter represents a list of values."]]
