def delete_all_contexts(self,
parent,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Deletes all active contexts in the specified session.
Example:
>>> import dialogflow_v2
>>>
>>> client = dialogflow_v2.ContextsClient()
>>>
>>> parent = client.session_path('[PROJECT]', '[SESSION]')
>>>
>>> client.delete_all_contexts(parent)
Args:
parent (str): Required. The name of the session to delete all contexts from. Format:
``projects/<Project ID>/agent/sessions/<Session 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.
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 'delete_all_contexts' not in self._inner_api_calls:
self._inner_api_calls[
'delete_all_contexts'] = google.api_core.gapic_v1.method.wrap_method(
self.transport.delete_all_contexts,
default_retry=self._method_configs['DeleteAllContexts'].
retry,
default_timeout=self._method_configs['DeleteAllContexts'].
timeout,
client_info=self._client_info,
)
request = context_pb2.DeleteAllContextsRequest(parent=parent, )
self._inner_api_calls['delete_all_contexts'](request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_delete_all_contexts(self):
channel = ChannelStub()
client = dialogflow_v2.ContextsClient(channel=channel)
# Setup Request
parent = client.session_path('[PROJECT]', '[SESSION]')
client.delete_all_contexts(parent)
assert len(channel.requests) == 1
expected_request = context_pb2.DeleteAllContextsRequest(parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_delete_all_contexts(self):
channel = ChannelStub()
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
parent = client.session_path('[PROJECT]', '[SESSION]')
client.delete_all_contexts(parent)
assert len(channel.requests) == 1
expected_request = context_pb2.DeleteAllContextsRequest(parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_delete_all_contexts(self):
channel = ChannelStub()
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
parent = "parent-995424086"
client.delete_all_contexts(parent)
assert len(channel.requests) == 1
expected_request = context_pb2.DeleteAllContextsRequest(parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def delete_all_contexts(
self,
parent,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes all active contexts in the specified session.
Example:
>>> import dialogflow_v2
>>>
>>> client = dialogflow_v2.ContextsClient()
>>>
>>> # TODO: Initialize `parent`:
>>> parent = ''
>>>
>>> client.delete_all_contexts(parent)
Args:
parent (str): Required. The name of the session to delete all contexts from.
Format: ``projects/<Project ID>/agent/sessions/<Session ID>`` or
``projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session 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.
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 "delete_all_contexts" not in self._inner_api_calls:
self._inner_api_calls[
"delete_all_contexts"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.delete_all_contexts,
default_retry=self._method_configs["DeleteAllContexts"].
retry,
default_timeout=self._method_configs["DeleteAllContexts"].
timeout,
client_info=self._client_info,
)
request = context_pb2.DeleteAllContextsRequest(parent=parent)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("parent", parent)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
self._inner_api_calls["delete_all_contexts"](request,
retry=retry,
timeout=timeout,
metadata=metadata)
