def __init__(
self,
method: Callable[...,
workflow_templates.ListWorkflowTemplatesResponse],
request: workflow_templates.ListWorkflowTemplatesRequest,
response: workflow_templates.ListWorkflowTemplatesResponse,
*,
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.dataproc_v1beta2.types.ListWorkflowTemplatesRequest):
The initial request object.
response (google.cloud.dataproc_v1beta2.types.ListWorkflowTemplatesResponse):
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 = workflow_templates.ListWorkflowTemplatesRequest(
request)
self._response = response
self._metadata = metadata
async def list_workflow_templates(
self,
request: workflow_templates.ListWorkflowTemplatesRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListWorkflowTemplatesAsyncPager:
r"""Lists workflows that match the specified filter in
the request.
Args:
request (:class:`~.workflow_templates.ListWorkflowTemplatesRequest`):
The request object. A request to list workflow templates
in a project.
parent (:class:`str`):
Required. The resource name of the region or location,
as described in
https://cloud.google.com/apis/design/resource_names.
- For ``projects.regions.workflowTemplates,list``, the
resource name of the region has the following format:
``projects/{project_id}/regions/{region}``
- For ``projects.locations.workflowTemplates.list``,
the resource name of the location has the following
format:
``projects/{project_id}/locations/{location}``
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.ListWorkflowTemplatesAsyncPager:
A response to a request to list
workflow templates in a project.
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.")
request = workflow_templates.ListWorkflowTemplatesRequest(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_workflow_templates,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded,
exceptions.InternalServerError,
exceptions.ServiceUnavailable,
),
),
default_timeout=600.0,
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.ListWorkflowTemplatesAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
def list_workflow_templates(
self,
request: workflow_templates.ListWorkflowTemplatesRequest = None,
*,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListWorkflowTemplatesPager:
r"""Lists workflows that match the specified filter in
the request.
Args:
request (:class:`~.workflow_templates.ListWorkflowTemplatesRequest`):
The request object. A request to list workflow templates
in a project.
parent (:class:`str`):
Required. The resource name of the region or location,
as described in
https://cloud.google.com/apis/design/resource_names.
- For ``projects.regions.workflowTemplates,list``, the
resource name of the region has the following format:
``projects/{project_id}/regions/{region}``
- For ``projects.locations.workflowTemplates.list``,
the resource name of the location has the following
format:
``projects/{project_id}/locations/{location}``
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.ListWorkflowTemplatesPager:
A response to a request to list
workflow templates in a project.
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 workflow_templates.ListWorkflowTemplatesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, workflow_templates.ListWorkflowTemplatesRequest):
request = workflow_templates.ListWorkflowTemplatesRequest(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_workflow_templates]
# 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.ListWorkflowTemplatesPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response