google.cloud.dialogflow.v2.Context */ class Context extends \Google\Protobuf\Internal\Message { /** * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, * or `projects//agent/environments//users//sessions//contexts/`. * The `Context ID` is always converted to lowercase, may only contain * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. * If `Environment ID` is not specified, we assume default 'draft' * environment. If `User ID` is not specified, we assume default '-' user. * The following context names are reserved for internal use by Dialogflow. * You should not use these contexts or create contexts with these names: * * `__system_counters__` * * `*_id_dialog_context` * * `*_dialog_params_size` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; */ private $name = ''; /** * Optional. The number of conversational query requests after which the * context expires. The default is `0`. If set to `0`, the context expires * immediately. Contexts expire automatically after 20 minutes if there * are no matching queries. * * Generated from protobuf field int32 lifespan_count = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $lifespan_count = 0; /** * Optional. The collection of parameters associated with this context. * Depending on your protocol or client library language, this is a * map, associative array, symbol table, dictionary, or JSON object * composed of a collection of (MapKey, MapValue) pairs: * - MapKey type: string * - MapKey value: parameter name * - MapValue type: * - If parameter's entity type is a composite entity: map * - Else: depending on parameter value type, could be one of string, * number, boolean, null, list or map * - MapValue value: * - If parameter's entity type is a composite entity: * map from composite entity property names to property values * - Else: parameter value * * Generated from protobuf field .google.protobuf.Struct parameters = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $parameters = null; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $name * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, * or `projects//agent/environments//users//sessions//contexts/`. * The `Context ID` is always converted to lowercase, may only contain * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. * If `Environment ID` is not specified, we assume default 'draft' * environment. If `User ID` is not specified, we assume default '-' user. * The following context names are reserved for internal use by Dialogflow. * You should not use these contexts or create contexts with these names: * * `__system_counters__` * * `*_id_dialog_context` * * `*_dialog_params_size` * @type int $lifespan_count * Optional. The number of conversational query requests after which the * context expires. The default is `0`. If set to `0`, the context expires * immediately. Contexts expire automatically after 20 minutes if there * are no matching queries. * @type \Google\Protobuf\Struct $parameters * Optional. The collection of parameters associated with this context. * Depending on your protocol or client library language, this is a * map, associative array, symbol table, dictionary, or JSON object * composed of a collection of (MapKey, MapValue) pairs: * - MapKey type: string * - MapKey value: parameter name * - MapValue type: * - If parameter's entity type is a composite entity: map * - Else: depending on parameter value type, could be one of string, * number, boolean, null, list or map * - MapValue value: * - If parameter's entity type is a composite entity: * map from composite entity property names to property values * - Else: parameter value * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Dialogflow\V2\Context::initOnce(); parent::__construct($data); } /** * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, * or `projects//agent/environments//users//sessions//contexts/`. * The `Context ID` is always converted to lowercase, may only contain * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. * If `Environment ID` is not specified, we assume default 'draft' * environment. If `User ID` is not specified, we assume default '-' user. * The following context names are reserved for internal use by Dialogflow. * You should not use these contexts or create contexts with these names: * * `__system_counters__` * * `*_id_dialog_context` * * `*_dialog_params_size` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getName() { return $this->name; } /** * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, * or `projects//agent/environments//users//sessions//contexts/`. * The `Context ID` is always converted to lowercase, may only contain * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. * If `Environment ID` is not specified, we assume default 'draft' * environment. If `User ID` is not specified, we assume default '-' user. * The following context names are reserved for internal use by Dialogflow. * You should not use these contexts or create contexts with these names: * * `__system_counters__` * * `*_id_dialog_context` * * `*_dialog_params_size` * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ public function setName($var) { GPBUtil::checkString($var, True); $this->name = $var; return $this; } /** * Optional. The number of conversational query requests after which the * context expires. The default is `0`. If set to `0`, the context expires * immediately. Contexts expire automatically after 20 minutes if there * are no matching queries. * * Generated from protobuf field int32 lifespan_count = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getLifespanCount() { return $this->lifespan_count; } /** * Optional. The number of conversational query requests after which the * context expires. The default is `0`. If set to `0`, the context expires * immediately. Contexts expire automatically after 20 minutes if there * are no matching queries. * * Generated from protobuf field int32 lifespan_count = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ public function setLifespanCount($var) { GPBUtil::checkInt32($var); $this->lifespan_count = $var; return $this; } /** * Optional. The collection of parameters associated with this context. * Depending on your protocol or client library language, this is a * map, associative array, symbol table, dictionary, or JSON object * composed of a collection of (MapKey, MapValue) pairs: * - MapKey type: string * - MapKey value: parameter name * - MapValue type: * - If parameter's entity type is a composite entity: map * - Else: depending on parameter value type, could be one of string, * number, boolean, null, list or map * - MapValue value: * - If parameter's entity type is a composite entity: * map from composite entity property names to property values * - Else: parameter value * * Generated from protobuf field .google.protobuf.Struct parameters = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Struct|null */ public function getParameters() { return $this->parameters; } public function hasParameters() { return isset($this->parameters); } public function clearParameters() { unset($this->parameters); } /** * Optional. The collection of parameters associated with this context. * Depending on your protocol or client library language, this is a * map, associative array, symbol table, dictionary, or JSON object * composed of a collection of (MapKey, MapValue) pairs: * - MapKey type: string * - MapKey value: parameter name * - MapValue type: * - If parameter's entity type is a composite entity: map * - Else: depending on parameter value type, could be one of string, * number, boolean, null, list or map * - MapValue value: * - If parameter's entity type is a composite entity: * map from composite entity property names to property values * - Else: parameter value * * Generated from protobuf field .google.protobuf.Struct parameters = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\Struct $var * @return $this */ public function setParameters($var) { GPBUtil::checkMessage($var, \Google\Protobuf\Struct::class); $this->parameters = $var; return $this; } }