def test_update_job(self):
# Setup Expected Response
name = "name3373707"
description = "description-1724546052"
schedule = "schedule-697920873"
time_zone = "timeZone36848094"
expected_response = {
"name": name,
"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_v1beta1.CloudSchedulerClient()
# Setup Request
job = {}
response = client.update_job(job)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = cloudscheduler_pb2.UpdateJobRequest(job=job)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_update_job(self):
# Setup Expected Response
name = 'name3373707'
description = 'description-1724546052'
schedule = 'schedule-697920873'
time_zone = 'timeZone36848094'
expected_response = {
'name': name,
'description': description,
'schedule': schedule,
'time_zone': time_zone
}
expected_response = job_pb2.Job(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = scheduler_v1beta1.CloudSchedulerClient(channel=channel)
# Setup Request
job = {}
response = client.update_job(job)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = cloudscheduler_pb2.UpdateJobRequest(job=job)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def update_job(
self,
job,
update_mask=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Updates a job.
If successful, the updated ``Job`` is returned. If the job does not
exist, ``NOT_FOUND`` is returned.
If UpdateJob does not successfully return, it is possible for the job to
be in an ``Job.State.UPDATE_FAILED`` state. A job in this state may not
be executed. If this happens, retry the UpdateJob request until a
successful response is received.
Example:
>>> from google.cloud import scheduler_v1beta1
>>>
>>> client = scheduler_v1beta1.CloudSchedulerClient()
>>>
>>> # TODO: Initialize `job`:
>>> job = {}
>>>
>>> response = client.update_job(job)
Args:
job (Union[dict, ~google.cloud.scheduler_v1beta1.types.Job]): Required. The new job properties. ``name`` must be specified.
Output only fields cannot be modified using UpdateJob. Any value
specified for an output only field will be ignored.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.scheduler_v1beta1.types.Job`
update_mask (Union[dict, ~google.cloud.scheduler_v1beta1.types.FieldMask]): A mask used to specify which fields of the job are being updated.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.scheduler_v1beta1.types.FieldMask`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
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_v1beta1.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 "update_job" not in self._inner_api_calls:
self._inner_api_calls[
"update_job"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.update_job,
default_retry=self._method_configs["UpdateJob"].retry,
default_timeout=self._method_configs["UpdateJob"].timeout,
client_info=self._client_info,
)
request = cloudscheduler_pb2.UpdateJobRequest(job=job,
update_mask=update_mask)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("job.name", job.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["update_job"](request,
retry=retry,
timeout=timeout,
metadata=metadata)