As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

WorkflowTemplateService

class google.cloud.dataproc_v1.services.workflow_template_service.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/.nox/docs/lib/python3.8/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>)[source]

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

Instantiates the workflow template service client.

Parameters
  • 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static cluster_path(project: str, location: str, cluster: str)str

Returns a fully-qualified cluster string.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate[source]

Creates new workflow template.

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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

A Dataproc workflow template resource.

Return type

google.cloud.dataproc_v1.types.WorkflowTemplate

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

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

Parameters
  • request (google.cloud.dataproc_v1.types.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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowTemplateServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowTemplateServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowTemplateServiceAsyncClient

get_transport_class()Type[google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

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

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

Parameters
  • request (google.cloud.dataproc_v1.types.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

A Dataproc workflow template resource.

Return type

google.cloud.dataproc_v1.types.WorkflowTemplate

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.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. Also see Using WorkflowMetadata.

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

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.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 {}.

Return type

google.api_core.operation_async.AsyncOperation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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. Also see Using WorkflowMetadata.

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

Parameters
  • request (google.cloud.dataproc_v1.types.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 (Sequence[google.cloud.dataproc_v1.types.InstantiateWorkflowTemplateRequest.ParametersEntry]) –

    Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.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 {}.

Return type

google.api_core.operation_async.AsyncOperation

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

Lists workflows that match the specified filter in the request.

Parameters
  • request (google.cloud.dataproc_v1.types.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

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

Return type

google.cloud.dataproc_v1.services.workflow_template_service.pagers.ListWorkflowTemplatesAsyncPager

static parse_cluster_path(path: str)Dict[str, str]

Parses a cluster path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_service_path(path: str)Dict[str, str]

Parses a service path into its component segments.

static parse_workflow_template_path(path: str)Dict[str, str]

Parses a workflow_template path into its component segments.

static service_path(project: str, location: str, service: str)str

Returns a fully-qualified service string.

property transport: google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

WorkflowTemplateServiceTransport

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate[source]

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

Parameters
Returns

A Dataproc workflow template resource.

Return type

google.cloud.dataproc_v1.types.WorkflowTemplate

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

Returns a fully-qualified workflow_template string.

class google.cloud.dataproc_v1.services.workflow_template_service.WorkflowTemplateServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the workflow template service client.

Parameters
  • 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 (google.api_core.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.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static cluster_path(project: str, location: str, cluster: str)str[source]

Returns a fully-qualified cluster string.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate[source]

Creates new workflow template.

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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

A Dataproc workflow template resource.

Return type

google.cloud.dataproc_v1.types.WorkflowTemplate

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

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

Parameters
  • request (google.cloud.dataproc_v1.types.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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowTemplateServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowTemplateServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

WorkflowTemplateServiceClient

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

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

Parameters
  • request (google.cloud.dataproc_v1.types.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

A Dataproc workflow template resource.

Return type

google.cloud.dataproc_v1.types.WorkflowTemplate

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Instantiates a template and begins execution.

This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.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. Also see Using WorkflowMetadata.

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

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.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 {}.

Return type

google.api_core.operation.Operation

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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. Also see Using WorkflowMetadata.

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

Parameters
  • request (google.cloud.dataproc_v1.types.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 (Sequence[google.cloud.dataproc_v1.types.InstantiateWorkflowTemplateRequest.ParametersEntry]) –

    Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 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

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.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 {}.

Return type

google.api_core.operation.Operation

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

Lists workflows that match the specified filter in the request.

Parameters
  • request (google.cloud.dataproc_v1.types.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

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

Return type

google.cloud.dataproc_v1.services.workflow_template_service.pagers.ListWorkflowTemplatesPager

static parse_cluster_path(path: str)Dict[str, str][source]

Parses a cluster path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_service_path(path: str)Dict[str, str][source]

Parses a service path into its component segments.

static parse_workflow_template_path(path: str)Dict[str, str][source]

Parses a workflow_template path into its component segments.

static service_path(project: str, location: str, service: str)str[source]

Returns a fully-qualified service string.

property transport: google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

WorkflowTemplateServiceTransport

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate[source]

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

Parameters
Returns

A Dataproc workflow template resource.

Return type

google.cloud.dataproc_v1.types.WorkflowTemplate

static workflow_template_path(project: str, region: str, workflow_template: str)str[source]

Returns a fully-qualified workflow_template string.

class google.cloud.dataproc_v1.services.workflow_template_service.pagers.ListWorkflowTemplatesAsyncPager(method: Callable[[...], Awaitable[google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesResponse]], request: google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesRequest, response: google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_workflow_templates requests.

This class thinly wraps an initial google.cloud.dataproc_v1.types.ListWorkflowTemplatesResponse object, and provides an __aiter__ method to iterate through its templates field.

If there are more pages, the __aiter__ method will make additional ListWorkflowTemplates requests and continue to iterate through the templates field on the corresponding responses.

All the usual google.cloud.dataproc_v1.types.ListWorkflowTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dataproc_v1.services.workflow_template_service.pagers.ListWorkflowTemplatesPager(method: Callable[[...], google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesResponse], request: google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesRequest, response: google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_workflow_templates requests.

This class thinly wraps an initial google.cloud.dataproc_v1.types.ListWorkflowTemplatesResponse object, and provides an __iter__ method to iterate through its templates field.

If there are more pages, the __iter__ method will make additional ListWorkflowTemplates requests and continue to iterate through the templates field on the corresponding responses.

All the usual google.cloud.dataproc_v1.types.ListWorkflowTemplatesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters