def delete_workflow_template(
self,
name,
version=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes a workflow template. It does not cancel in-progress workflows.
Example:
>>> from google.cloud import dataproc_v1
>>>
>>> client = dataproc_v1.WorkflowTemplateServiceClient()
>>>
>>> name = client.workflow_template_path('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]')
>>>
>>> client.delete_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 of the form
``projects/{project_id}/regions/{region}/workflowTemplates/{template_id}``
version (int): Optional. The version of workflow template to delete. If specified,
will only delete the template if the current server version matches
specified version.
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.
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 "delete_workflow_template" not in self._inner_api_calls:
self._inner_api_calls[
"delete_workflow_template"
] = google.api_core.gapic_v1.method.wrap_method(
self.transport.delete_workflow_template,
default_retry=self._method_configs["DeleteWorkflowTemplate"].retry,
default_timeout=self._method_configs["DeleteWorkflowTemplate"].timeout,
client_info=self._client_info,
)
request = workflow_templates_pb2.DeleteWorkflowTemplateRequest(
name=name, version=version
)
self._inner_api_calls["delete_workflow_template"](
request, retry=retry, timeout=timeout, metadata=metadata
)
def test_delete_workflow_template(self):
channel = ChannelStub()
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]")
client.delete_workflow_template(name)
assert len(channel.requests) == 1
expected_request = workflow_templates_pb2.DeleteWorkflowTemplateRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
