Google Cloud Dialogflow V2 Client - Class Parameter (1.4.0)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

The unique identifier of this parameter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Required. The name of the parameter.

Returns
TypeDescription
string

setDisplayName

Required. The name of the parameter.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getMandatory

Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

Returns
TypeDescription
bool

setMandatory

Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string[]
Returns
TypeDescription
$this

getIsList

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

Returns
TypeDescription
bool

setIsList

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this