def test_get_workflow_template(self):
# Setup Expected Response
id_ = "id3355"
name_2 = "name2-1052831874"
version = 351608024
expected_response = {"id": id_, "name": name_2, "version": version}
expected_response = workflow_templates_pb2.WorkflowTemplate(
**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 = dataproc_v1.WorkflowTemplateServiceClient()
# Setup Request
name = client.workflow_template_path("[PROJECT]", "[REGION]",
"[WORKFLOW_TEMPLATE]")
response = client.get_workflow_template(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = workflow_templates_pb2.GetWorkflowTemplateRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def get_workflow_template(
self,
name,
version=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Retrieves the latest workflow template.
Can retrieve previously instantiated template by specifying optional
version parameter.
Example:
>>> from google.cloud import dataproc_v1
>>>
>>> client = dataproc_v1.WorkflowTemplateServiceClient()
>>>
>>> name = client.workflow_template_path('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]')
>>>
>>> response = client.get_workflow_template(name)
Args:
name (str): Required. The resource name of the workflow template, as described in
https://cloud.google.com/apis/design/resource\_names.
- For ``projects.regions.workflowTemplates.get``, the resource name of
the template has the following format:
``projects/{project_id}/regions/{region}/workflowTemplates/{template_id}``
- For ``projects.locations.workflowTemplates.get``, the resource name
of the template has the following format:
``projects/{project_id}/locations/{location}/workflowTemplates/{template_id}``
version (int): Optional. The version of workflow template to retrieve. Only previously
instantiated versions can be retrieved.
If unspecified, retrieves the current version.
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.dataproc_v1.types.WorkflowTemplate` 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 "get_workflow_template" not in self._inner_api_calls:
self._inner_api_calls[
"get_workflow_template"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_workflow_template,
default_retry=self._method_configs["GetWorkflowTemplate"].
retry,
default_timeout=self.
_method_configs["GetWorkflowTemplate"].timeout,
client_info=self._client_info,
)
request = workflow_templates_pb2.GetWorkflowTemplateRequest(
name=name, version=version)
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["get_workflow_template"](
request, retry=retry, timeout=timeout, metadata=metadata)