def test_list_knowledge_bases(self):
# Setup Expected Response
next_page_token = ""
knowledge_bases_element = {}
knowledge_bases = [knowledge_bases_element]
expected_response = {
"next_page_token": next_page_token,
"knowledge_bases": knowledge_bases,
}
expected_response = knowledge_base_pb2.ListKnowledgeBasesResponse(
**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_v2beta1.KnowledgeBasesClient()
# Setup Request
parent = client.project_path("[PROJECT]")
paged_list_response = client.list_knowledge_bases(parent)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.knowledge_bases[0] == resources[0]
assert len(channel.requests) == 1
expected_request = knowledge_base_pb2.ListKnowledgeBasesRequest(
parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_list_knowledge_bases(self):
# Setup Expected Response
next_page_token = ''
knowledge_bases_element = {}
knowledge_bases = [knowledge_bases_element]
expected_response = {
'next_page_token': next_page_token,
'knowledge_bases': knowledge_bases
}
expected_response = knowledge_base_pb2.ListKnowledgeBasesResponse(
**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = dialogflow_v2beta1.KnowledgeBasesClient(channel=channel)
# Setup Request
parent = client.project_path('[PROJECT]')
paged_list_response = client.list_knowledge_bases(parent)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.knowledge_bases[0] == resources[0]
assert len(channel.requests) == 1
expected_request = knowledge_base_pb2.ListKnowledgeBasesRequest(
parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def list_knowledge_bases(self,
parent,
page_size=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Returns the list of all knowledge bases of the specified agent.
Example:
>>> import dialogflow_v2beta1
>>>
>>> client = dialogflow_v2beta1.KnowledgeBasesClient()
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # Iterate over all results
>>> for element in client.list_knowledge_bases(parent):
... # process element
... pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_knowledge_bases(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): Required. The project to list of knowledge bases for. Format:
``projects/<Project ID>``.
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
resource, this parameter does not affect the return value. If page
streaming is performed per-page, this determines the maximum number
of resources in a page.
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.gax.PageIterator` instance. By default, this
is an iterable of :class:`~google.cloud.dialogflow_v2beta1.types.KnowledgeBase` instances.
This object can also be configured to iterate over the pages
of the response through the `options` parameter.
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 'list_knowledge_bases' not in self._inner_api_calls:
self._inner_api_calls[
'list_knowledge_bases'] = google.api_core.gapic_v1.method.wrap_method(
self.transport.list_knowledge_bases,
default_retry=self._method_configs['ListKnowledgeBases'].
retry,
default_timeout=self._method_configs['ListKnowledgeBases'].
timeout,
client_info=self._client_info,
)
request = knowledge_base_pb2.ListKnowledgeBasesRequest(
parent=parent,
page_size=page_size,
)
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)
iterator = google.api_core.page_iterator.GRPCIterator(
client=None,
method=functools.partial(
self._inner_api_calls['list_knowledge_bases'],
retry=retry,
timeout=timeout,
metadata=metadata),
request=request,
items_field='knowledge_bases',
request_token_field='page_token',
response_token_field='next_page_token',
)
return iterator