def get_context(self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Retrieves the specified context.
Example:
>>> import dialogflow_v2
>>>
>>> client = dialogflow_v2.ContextsClient()
>>>
>>> name = client.context_path('[PROJECT]', '[SESSION]', '[CONTEXT]')
>>>
>>> response = client.get_context(name)
Args:
name (str): Required. The name of the context. Format:
``projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.cloud.dialogflow_v2.types.Context` instance.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
# Wrap the transport method to add retry and timeout logic.
if 'get_context' not in self._inner_api_calls:
self._inner_api_calls[
'get_context'] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_context,
default_retry=self._method_configs['GetContext'].retry,
default_timeout=self._method_configs['GetContext'].timeout,
client_info=self._client_info,
)
request = context_pb2.GetContextRequest(name=name, )
return self._inner_api_calls['get_context'](request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_get_context(self):
# Setup Expected Response
name_2 = 'name2-1052831874'
lifespan_count = 1178775510
expected_response = {'name': name_2, 'lifespan_count': lifespan_count}
expected_response = context_pb2.Context(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = dialogflow_v2.ContextsClient(channel=channel)
# Setup Request
name = client.context_path('[PROJECT]', '[SESSION]', '[CONTEXT]')
response = client.get_context(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = context_pb2.GetContextRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_get_context(self):
# Setup Expected Response
name_2 = 'name2-1052831874'
lifespan_count = 1178775510
expected_response = {'name': name_2, 'lifespan_count': lifespan_count}
expected_response = context_pb2.Context(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch('google.api_core.grpc_helpers.create_channel')
with patch as create_channel:
create_channel.return_value = channel
client = dialogflow_v2.ContextsClient()
# Setup Request
name = client.context_path('[PROJECT]', '[SESSION]', '[CONTEXT]')
response = client.get_context(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = context_pb2.GetContextRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_get_context(self):
# Setup Expected Response
name_2 = "name2-1052831874"
lifespan_count = 1178775510
expected_response = {"name": name_2, "lifespan_count": lifespan_count}
expected_response = context_pb2.Context(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = dialogflow_v2.ContextsClient()
# Setup Request
name = "name3373707"
response = client.get_context(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = context_pb2.GetContextRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def get_context(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Retrieves the specified context.
Example:
>>> import dialogflow_v2
>>>
>>> client = dialogflow_v2.ContextsClient()
>>>
>>> # TODO: Initialize `name`:
>>> name = ''
>>>
>>> response = client.get_context(name)
Args:
name (str): Required. The name of the context. Format:
``projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>``
or
``projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>``.
If ``Environment ID`` is not specified, we assume default 'draft'
environment. If ``User ID`` is not specified, we assume default '-'
user.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.cloud.dialogflow_v2.types.Context` instance.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
# Wrap the transport method to add retry and timeout logic.
if "get_context" not in self._inner_api_calls:
self._inner_api_calls[
"get_context"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_context,
default_retry=self._method_configs["GetContext"].retry,
default_timeout=self._method_configs["GetContext"].timeout,
client_info=self._client_info,
)
request = context_pb2.GetContextRequest(name=name)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("name", name)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
return self._inner_api_calls["get_context"](request,
retry=retry,
timeout=timeout,
metadata=metadata)