def __init__(self,
method: Callable[..., intent.ListIntentsResponse],
request: intent.ListIntentsRequest,
response: intent.ListIntentsResponse,
*,
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.ListIntentsRequest):
The initial request object.
response (google.cloud.dialogflow_v2.types.ListIntentsResponse):
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 = intent.ListIntentsRequest(request)
self._response = response
self._metadata = metadata
async def list_intents(
self,
request: intent.ListIntentsRequest = None,
*,
parent: str = None,
language_code: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListIntentsAsyncPager:
r"""Returns the list of all intents in the specified
agent.
Args:
request (:class:`google.cloud.dialogflow_v2.types.ListIntentsRequest`):
The request object. The request message for
[Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
parent (:class:`str`):
Required. The agent to list all intents from. Format:
``projects/<Project ID>/agent`` or
``projects/<Project ID>/locations/<Location ID>/agent``.
Alternatively, you can specify the environment to list
intents for. Format:
``projects/<Project ID>/agent/environments/<Environment ID>``
or
``projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>``.
Note: training phrases of the intents will not be
returned for non-draft environment.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
language_code (:class:`str`):
Optional. The language used to access language-specific
data. If not specified, the agent's default language is
used. For more information, see `Multilingual intent and
entity
data <https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity>`__.
This corresponds to the ``language_code`` 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.intents.pagers.ListIntentsAsyncPager:
The response message for
[Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
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, language_code])
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 = intent.ListIntentsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if language_code is not None:
request.language_code = language_code
# 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_intents,
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.ListIntentsAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
