def test_list_jobs(self):
# Setup Expected Response
next_page_token = ""
jobs_element = {}
jobs = [jobs_element]
expected_response = {"next_page_token": next_page_token, "jobs": jobs}
expected_response = cloudscheduler_pb2.ListJobsResponse(**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 = scheduler_v1.CloudSchedulerClient()
# Setup Request
parent = client.location_path("[PROJECT]", "[LOCATION]")
paged_list_response = client.list_jobs(parent)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.jobs[0] == resources[0]
assert len(channel.requests) == 1
expected_request = cloudscheduler_pb2.ListJobsRequest(parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def list_jobs(
self,
parent,
page_size=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Lists jobs.
Example:
>>> from google.cloud import scheduler_v1
>>>
>>> client = scheduler_v1.CloudSchedulerClient()
>>>
>>> parent = client.location_path('[PROJECT]', '[LOCATION]')
>>>
>>> # Iterate over all results
>>> for element in client.list_jobs(parent):
... # process element
... pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_jobs(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): Required.
The location name. For example:
``projects/PROJECT_ID/locations/LOCATION_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.scheduler_v1.types.Job` 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_jobs" not in self._inner_api_calls:
self._inner_api_calls[
"list_jobs"
] = google.api_core.gapic_v1.method.wrap_method(
self.transport.list_jobs,
default_retry=self._method_configs["ListJobs"].retry,
default_timeout=self._method_configs["ListJobs"].timeout,
client_info=self._client_info,
)
request = cloudscheduler_pb2.ListJobsRequest(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_jobs"],
retry=retry,
timeout=timeout,
metadata=metadata,
),
request=request,
items_field="jobs",
request_token_field="page_token",
response_token_field="next_page_token",
)
return iterator