Google Cloud Dialogflow V2 Client - Class Parameter (1.16.0)

Version 1.16.0

• 1.17.0 (latest)
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.3
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.0
• 1.7.2
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.1

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

Represents intent parameters.

Generated from protobuf message google.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 the value yields 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 the value yields 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 the value yields 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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPrompts

Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getIsList

Optional. Indicates whether the parameter represents a list of values.

Returns
Type	Description
bool

setIsList

Optional. Indicates whether the parameter represents a list of values.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this