def __init__(self,
method: Callable[..., agent.SearchAgentsResponse],
request: agent.SearchAgentsRequest,
response: agent.SearchAgentsResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.cloud.dialogflow_v2.types.SearchAgentsRequest):
The initial request object.
response (google.cloud.dialogflow_v2.types.SearchAgentsResponse):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = agent.SearchAgentsRequest(request)
self._response = response
self._metadata = metadata
def search_agents(
self,
request: agent.SearchAgentsRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.SearchAgentsPager:
r"""Returns the list of agents.
Since there is at most one conversational agent per project,
this method is useful primarily for listing all agents across
projects the caller has access to. One can achieve that with a
wildcard project collection id "-". Refer to `List
Sub-Collections <https://cloud.google.com/apis/design/design_patterns#list_sub-collections>`__.
Args:
request (:class:`~.agent.SearchAgentsRequest`):
The request object. The request message for
[Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].
parent (:class:`str`):
Required. The project to list agents from. Format:
``projects/<Project ID or '-'>``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.pagers.SearchAgentsPager:
The response message for
[Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
# Minor optimization to avoid making a copy if the user passes
# in a agent.SearchAgentsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, agent.SearchAgentsRequest):
request = agent.SearchAgentsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.search_agents]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.SearchAgentsPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
async def search_agents(
self,
request: Union[agent.SearchAgentsRequest, dict] = None,
*,
parent: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.SearchAgentsAsyncPager:
r"""Returns the list of agents.
Since there is at most one conversational agent per project,
this method is useful primarily for listing all agents across
projects the caller has access to. One can achieve that with a
wildcard project collection id "-". Refer to `List
Sub-Collections <https://cloud.google.com/apis/design/design_patterns#list_sub-collections>`__.
.. code-block:: python
from google.cloud import dialogflow_v2
async def sample_search_agents():
# Create a client
client = dialogflow_v2.AgentsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2.SearchAgentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_agents(request=request)
# Handle the response
async for response in page_result:
print(response)
Args:
request (Union[google.cloud.dialogflow_v2.types.SearchAgentsRequest, dict]):
The request object. The request message for
[Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].
parent (:class:`str`):
Required. The project to list agents from. Format:
``projects/<Project ID or '-'>``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.dialogflow_v2.services.agents.pagers.SearchAgentsAsyncPager:
The response message for
[Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([parent])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
request = agent.SearchAgentsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.search_agents,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
)
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__aiter__` convenience method.
response = pagers.SearchAgentsAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
