def test_pause_job(self):
# Setup Expected Response
name_2 = "name2-1052831874"
description = "description-1724546052"
schedule = "schedule-697920873"
time_zone = "timeZone36848094"
expected_response = {
"name": name_2,
"description": description,
"schedule": schedule,
"time_zone": time_zone,
}
expected_response = job_pb2.Job(**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
name = client.job_path("[PROJECT]", "[LOCATION]", "[JOB]")
response = client.pause_job(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = cloudscheduler_pb2.PauseJobRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def pause_job(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Pauses a job.
If a job is paused then the system will stop executing the job until it
is re-enabled via ``ResumeJob``. The state of the job is stored in
``state``; if paused it will be set to ``Job.State.PAUSED``. A job must
be in ``Job.State.ENABLED`` to be paused.
Example:
>>> from google.cloud import scheduler_v1
>>>
>>> client = scheduler_v1.CloudSchedulerClient()
>>>
>>> name = client.job_path('[PROJECT]', '[LOCATION]', '[JOB]')
>>>
>>> response = client.pause_job(name)
Args:
name (str): Required.
The job name. For example:
``projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID``.
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.cloud.scheduler_v1.types.Job` instance.
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 "pause_job" not in self._inner_api_calls:
self._inner_api_calls[
"pause_job"
] = google.api_core.gapic_v1.method.wrap_method(
self.transport.pause_job,
default_retry=self._method_configs["PauseJob"].retry,
default_timeout=self._method_configs["PauseJob"].timeout,
client_info=self._client_info,
)
request = cloudscheduler_pb2.PauseJobRequest(name=name)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("name", name)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header
)
metadata.append(routing_metadata)
return self._inner_api_calls["pause_job"](
request, retry=retry, timeout=timeout, metadata=metadata
)