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.
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.
Generated from protobuf field string name = 1;
string
setName
The unique identifier of this parameter.
Generated from protobuf field string name = 1;
var
string
$this
getDisplayName
Required. The name of the parameter.
Generated from protobuf field string display_name = 2;
string
setDisplayName
Required. The name of the parameter.
Generated from protobuf field string display_name = 2;
var
string
$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.
Generated from protobuf field string value = 3 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field string value = 3 [(.google.api.field_behavior) = OPTIONAL];
var
string
$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
.
Generated from protobuf field string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
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
.
Generated from protobuf field string default_value = 4 [(.google.api.field_behavior) = OPTIONAL];
var
string
$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.
Generated from protobuf field string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field string entity_type_display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getMandatory
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
Generated from protobuf field bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];
bool
setMandatory
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
Generated from protobuf field bool mandatory = 6 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getPrompts
Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
Generated from protobuf field repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field repeated string prompts = 7 [(.google.api.field_behavior) = OPTIONAL];
var
string[]
$this
getIsList
Optional. Indicates whether the parameter represents a list of values.
Generated from protobuf field bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];
bool
setIsList
Optional. Indicates whether the parameter represents a list of values.
Generated from protobuf field bool is_list = 8 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
