Class WorkflowTemplateServiceAsyncClient (2.3.1)

WorkflowTemplateServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dataproc/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The API interface for managing Workflow Templates in the Dataproc API.

Properties

transport

Return the transport used by the client instance.

Returns
TypeDescription
WorkflowTemplateServiceTransportThe transport used by the client instance.

Methods

WorkflowTemplateServiceAsyncClient

WorkflowTemplateServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dataproc/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the workflow template service client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, .WorkflowTemplateServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_workflow_template

create_workflow_template(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.CreateWorkflowTemplateRequest] = None, *, parent: Optional[str] = None, template: Optional[google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates new workflow template.

Parameters
NameDescription
request .workflow_templates.CreateWorkflowTemplateRequest

The request object. A request to create a workflow template.

parent str

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} - For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

template .workflow_templates.WorkflowTemplate

Required. The Dataproc workflow template to create. This corresponds to the template field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.workflow_templates.WorkflowTemplateA Dataproc workflow template resource.

delete_workflow_template

delete_workflow_template(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.DeleteWorkflowTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a workflow template. It does not cancel in- rogress workflows.

Parameters
NameDescription
request .workflow_templates.DeleteWorkflowTemplateRequest

The request object. A request to delete a workflow template. Currently started workflows will remain running.

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.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

get_transport_class

get_transport_class()

Return an appropriate transport class.

get_workflow_template

get_workflow_template(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.GetWorkflowTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the latest workflow template. Can retrieve previously instantiated template by specifying optional version parameter.

Parameters
NameDescription
request .workflow_templates.GetWorkflowTemplateRequest

The request object. A request to fetch a workflow template.

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} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.workflow_templates.WorkflowTemplateA Dataproc workflow template resource.

instantiate_inline_workflow_template

instantiate_inline_workflow_template(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.InstantiateInlineWorkflowTemplateRequest] = None, *, parent: Optional[str] = None, template: Optional[google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Instantiates a template and begins execution.

This method is equivalent to executing the sequence xref_CreateWorkflowTemplate, xref_InstantiateWorkflowTemplate, xref_DeleteWorkflowTemplate.

The returned Operation can be used to track execution of workflow by polling operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata>. Also see Using WorkflowMetadata <https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata>.

On successful completion, Operation.response][google.longrunning.Operation.response] will be Empty][google.protobuf.Empty].

Parameters
NameDescription
request .workflow_templates.InstantiateInlineWorkflowTemplateRequest

The request object. A request to instantiate an inline workflow template.

parent str

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} - For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

template .workflow_templates.WorkflowTemplate

Required. The workflow template to instantiate. This corresponds to the template field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be
.empty.Empty
: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: :: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

instantiate_workflow_template

instantiate_workflow_template(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.InstantiateWorkflowTemplateRequest] = None, *, name: Optional[str] = None, parameters: Optional[Sequence[google.cloud.dataproc_v1.types.workflow_templates.InstantiateWorkflowTemplateRequest.ParametersEntry]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Instantiates a template and begins execution.

The returned Operation can be used to track execution of workflow by polling operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The Operation.metadata][google.longrunning.Operation.metadata] will be WorkflowMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata>. Also see Using WorkflowMetadata <https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata>.

On successful completion, Operation.response][google.longrunning.Operation.response] will be Empty][google.protobuf.Empty].

Parameters
NameDescription
request .workflow_templates.InstantiateWorkflowTemplateRequest

The request object. A request to instantiate a workflow template.

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.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} - For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

parameters :class:Sequence[.workflow_templates.InstantiateWorkflowTemplateRequest.ParametersEntry]

Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters. This corresponds to the parameters field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be
.empty.Empty
: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: :: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

list_workflow_templates

list_workflow_templates(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists workflows that match the specified filter in the request.

Parameters
NameDescription
request .workflow_templates.ListWorkflowTemplatesRequest

The request object. A request to list workflow templates in a project.

parent str

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. - For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} - For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.ListWorkflowTemplatesAsyncPagerA response to a request to list workflow templates in a project. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_workflow_template_path

parse_workflow_template_path(path: str)

Parse a workflow_template path into its component segments.

update_workflow_template

update_workflow_template(request: Optional[google.cloud.dataproc_v1.types.workflow_templates.UpdateWorkflowTemplateRequest] = None, *, template: Optional[google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters
NameDescription
request .workflow_templates.UpdateWorkflowTemplateRequest

The request object. A request to update a workflow template.

template .workflow_templates.WorkflowTemplate

Required. The updated workflow template. The template.version field must match the current version. This corresponds to the template field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.workflow_templates.WorkflowTemplateA Dataproc workflow template resource.

workflow_template_path

workflow_template_path(project: str, region: str, workflow_template: str)

Return a fully-qualified workflow_template string.