def __init__(self,
method: Callable[..., agent.ListAgentsResponse],
request: agent.ListAgentsRequest,
response: agent.ListAgentsResponse,
*,
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.dialogflowcx_v3beta1.types.ListAgentsRequest):
The initial request object.
response (google.cloud.dialogflowcx_v3beta1.types.ListAgentsResponse):
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.ListAgentsRequest(request)
self._response = response
self._metadata = metadata
def __init__(self,
method: Callable[..., Awaitable[agent.ListAgentsResponse]],
request: agent.ListAgentsRequest,
response: agent.ListAgentsResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (:class:`~.agent.ListAgentsRequest`):
The initial request object.
response (:class:`~.agent.ListAgentsResponse`):
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.ListAgentsRequest(request)
self._response = response
self._metadata = metadata
async def list_agents(
self,
request: agent.ListAgentsRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListAgentsAsyncPager:
r"""Returns the list of all agents in the specified
location.
Args:
request (:class:`~.agent.ListAgentsRequest`):
The request object. The request message for
[Agents.ListAgents][google.cloud.dialogflow.cx.v3beta1.Agents.ListAgents].
parent (:class:`str`):
Required. The location to list all agents for. Format:
``projects/<Project ID>/locations/<Location ID>``.
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.ListAgentsAsyncPager:
The response message for
[Agents.ListAgents][google.cloud.dialogflow.cx.v3beta1.Agents.ListAgents].
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.
if request is not None and any([parent]):
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
request = agent.ListAgentsRequest(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.list_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.ListAgentsAsyncPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
def list_agents(
self,
request: agent.ListAgentsRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListAgentsPager:
r"""Returns the list of all agents in the specified
location.
Args:
request (google.cloud.dialogflowcx_v3beta1.types.ListAgentsRequest):
The request object. The request message for
[Agents.ListAgents][google.cloud.dialogflow.cx.v3beta1.Agents.ListAgents].
parent (str):
Required. The location to list all agents for. Format:
``projects/<Project ID>/locations/<Location ID>``.
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.dialogflowcx_v3beta1.services.agents.pagers.ListAgentsPager:
The response message for
[Agents.ListAgents][google.cloud.dialogflow.cx.v3beta1.Agents.ListAgents].
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.ListAgentsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, agent.ListAgentsRequest):
request = agent.ListAgentsRequest(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.list_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.ListAgentsPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response
