Class WorkflowTemplateServiceClient (5.9.3)

WorkflowTemplateServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dataproc_v1.services.workflow_template_service.transports.base.WorkflowTemplateServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
`str`	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
`WorkflowTemplateServiceTransport`	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
`str`	The universe domain used by the client instance.

Methods

WorkflowTemplateServiceClient

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

Instantiates the workflow template service client.

Parameters
Name	Description
`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`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS 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. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`.operations_pb2.CancelOperationRequest` The request object. Request message for `CancelOperation` method.
`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.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_workflow_template

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

Creates new workflow template.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_create_workflow_template():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    template = dataproc_v1.WorkflowTemplate()
    template.id = "id_value"
    template.placement.managed_cluster.cluster_name = "cluster_name_value"
    template.jobs.hadoop_job.main_jar_file_uri = "main_jar_file_uri_value"
    template.jobs.step_id = "step_id_value"

    request = dataproc_v1.CreateWorkflowTemplateRequest(
        parent="parent_value",
        template=template,
    )

    # Make the request
    response = client.create_workflow_template(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.CreateWorkflowTemplateRequest, dict]` 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
Type	Description
`google.cloud.dataproc_v1.types.WorkflowTemplate`	A Dataproc workflow template resource.

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`.operations_pb2.DeleteOperationRequest` The request object. Request message for `DeleteOperation` method.
`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.

delete_workflow_template

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_delete_workflow_template():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    request = dataproc_v1.DeleteWorkflowTemplateRequest(
        name="name_value",
    )

    # Make the request
    client.delete_workflow_template(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.DeleteWorkflowTemplateRequest, dict]` 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
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`WorkflowTemplateServiceClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`WorkflowTemplateServiceClient`	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
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`WorkflowTemplateServiceClient`	The constructed client.

get_iam_policy

get_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters
Name	Description
`request`	`.iam_policy_pb2.GetIamPolicyRequest` The request object. Request message for `GetIamPolicy` method.
`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

Type Description

.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
`request`	`.operations_pb2.GetOperationRequest` The request object. Request message for `GetOperation` method.
`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
Type	Description
`.operations_pb2.Operation`	An `Operation` object.

get_workflow_template

get_workflow_template(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataproc_v1.types.workflow_templates.GetWorkflowTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_get_workflow_template():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    request = dataproc_v1.GetWorkflowTemplateRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_workflow_template(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.GetWorkflowTemplateRequest, dict]` 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
Type	Description
`google.cloud.dataproc_v1.types.WorkflowTemplate`	A Dataproc workflow template resource.

instantiate_inline_workflow_template

instantiate_inline_workflow_template(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataproc_v1.types.workflow_templates.InstantiateInlineWorkflowTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    template: typing.Optional[
        google.cloud.dataproc_v1.types.workflow_templates.WorkflowTemplate
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_instantiate_inline_workflow_template():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    template = dataproc_v1.WorkflowTemplate()
    template.id = "id_value"
    template.placement.managed_cluster.cluster_name = "cluster_name_value"
    template.jobs.hadoop_job.main_jar_file_uri = "main_jar_file_uri_value"
    template.jobs.step_id = "step_id_value"

    request = dataproc_v1.InstantiateInlineWorkflowTemplateRequest(
        parent="parent_value",
        template=template,
    )

    # Make the request
    operation = client.instantiate_inline_workflow_template(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.InstantiateInlineWorkflowTemplateRequest, dict]` 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

Type Description

google.api_core.operation.Operation 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); }

instantiate_workflow_template

instantiate_workflow_template(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataproc_v1.types.workflow_templates.InstantiateWorkflowTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    parameters: typing.Optional[typing.MutableMapping[str, str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Instantiates a template and begins execution.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_instantiate_workflow_template():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    request = dataproc_v1.InstantiateWorkflowTemplateRequest(
        name="name_value",
    )

    # Make the request
    operation = client.instantiate_workflow_template(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.InstantiateWorkflowTemplateRequest, dict]` 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`	`MutableMapping[str, str]` 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

Type Description

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
`request`	`.operations_pb2.ListOperationsRequest` The request object. Request message for `ListOperations` method.
`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
Type	Description
`.operations_pb2.ListOperationsResponse`	Response message for `ListOperations` method.

list_workflow_templates

list_workflow_templates(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataproc_v1.types.workflow_templates.ListWorkflowTemplatesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dataproc_v1.services.workflow_template_service.pagers.ListWorkflowTemplatesPager
)

Lists workflows that match the specified filter in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_list_workflow_templates():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    request = dataproc_v1.ListWorkflowTemplatesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_workflow_templates(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.ListWorkflowTemplatesRequest, dict]` 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
Type	Description
`google.cloud.dataproc_v1.services.workflow_template_service.pagers.ListWorkflowTemplatesPager`	A response to a request to list workflow templates in a project. Iterating over this object will yield results and resolve additional pages automatically.

node_group_path

node_group_path(project: str, region: str, cluster: str, node_group: str) -> str

Returns a fully-qualified node_group string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_node_group_path

parse_node_group_path(path: str) -> typing.Dict[str, str]

Parses a node_group path into its component segments.

parse_service_path

parse_service_path(path: str) -> typing.Dict[str, str]

Parses a service path into its component segments.

parse_workflow_template_path

parse_workflow_template_path(path: str) -> typing.Dict[str, str]

Parses a workflow_template path into its component segments.

service_path

service_path(project: str, location: str, service: str) -> str

Returns a fully-qualified service string.

set_iam_policy

set_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name	Description
`request`	`.iam_policy_pb2.SetIamPolicyRequest` The request object. Request message for `SetIamPolicy` method.
`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

Type Description

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
Name	Description
`request`	`.iam_policy_pb2.TestIamPermissionsRequest` The request object. Request message for `TestIamPermissions` method.
`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
Type	Description
`.iam_policy_pb2.TestIamPermissionsResponse`	Response message for `TestIamPermissions` method.

update_workflow_template

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataproc_v1

def sample_update_workflow_template():
    # Create a client
    client = dataproc_v1.WorkflowTemplateServiceClient()

    # Initialize request argument(s)
    template = dataproc_v1.WorkflowTemplate()
    template.id = "id_value"
    template.placement.managed_cluster.cluster_name = "cluster_name_value"
    template.jobs.hadoop_job.main_jar_file_uri = "main_jar_file_uri_value"
    template.jobs.step_id = "step_id_value"

    request = dataproc_v1.UpdateWorkflowTemplateRequest(
        template=template,
    )

    # Make the request
    response = client.update_workflow_template(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dataproc_v1.types.UpdateWorkflowTemplateRequest, dict]` The request object. A request to update a workflow template.
`template`	`google.cloud.dataproc_v1.types.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
Type	Description
`google.cloud.dataproc_v1.types.WorkflowTemplate`	A Dataproc workflow template resource.

workflow_template_path

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

Returns a fully-qualified workflow_template string.