Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::WorkflowTemplate (v1.9.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::WorkflowTemplate.

A Dataproc workflow template resource.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

• (::Google::Protobuf::Timestamp) — Output only. The time template was created.

• (::Google::Protobuf::Duration) — Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.

• value (::Google::Protobuf::Duration) — Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.

• (::Google::Protobuf::Duration) — Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.

• (::Google::Cloud::Dataproc::V1::WorkflowTemplate::EncryptionConfig) — Optional. Encryption settings for encrypting workflow template job arguments.

• value (::Google::Cloud::Dataproc::V1::WorkflowTemplate::EncryptionConfig) — Optional. Encryption settings for encrypting workflow template job arguments.

• (::Google::Cloud::Dataproc::V1::WorkflowTemplate::EncryptionConfig) — Optional. Encryption settings for encrypting workflow template job arguments.

• (::String)

• value (::String)

• (::String)

• (::Array<::Google::Cloud::Dataproc::V1::OrderedJob>) — Required. The Directed Acyclic Graph of Jobs to submit.

• value (::Array<::Google::Cloud::Dataproc::V1::OrderedJob>) — Required. The Directed Acyclic Graph of Jobs to submit.

• (::Array<::Google::Cloud::Dataproc::V1::OrderedJob>) — Required. The Directed Acyclic Graph of Jobs to submit.

• (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.

  Label keys must contain 1 to 63 characters, and must conform to RFC 1035.

  Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.

  No more than 32 labels can be associated with a template.

• value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.

  Label keys must contain 1 to 63 characters, and must conform to RFC 1035.

  Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.

  No more than 32 labels can be associated with a template.

• (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.

  Label keys must contain 1 to 63 characters, and must conform to RFC 1035.

  Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035.

  No more than 32 labels can be associated with a template.

• (::String) —

  Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

  • For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

  • For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

• (::Array<::Google::Cloud::Dataproc::V1::TemplateParameter>) — Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

• value (::Array<::Google::Cloud::Dataproc::V1::TemplateParameter>) — Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

• (::Array<::Google::Cloud::Dataproc::V1::TemplateParameter>) — Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

• (::Google::Cloud::Dataproc::V1::WorkflowTemplatePlacement) — Required. WorkflowTemplate scheduling information.

• value (::Google::Cloud::Dataproc::V1::WorkflowTemplatePlacement) — Required. WorkflowTemplate scheduling information.

• (::Google::Cloud::Dataproc::V1::WorkflowTemplatePlacement) — Required. WorkflowTemplate scheduling information.

• (::Google::Protobuf::Timestamp) — Output only. The time template was last updated.

• (::Integer) — Optional. Used to perform a consistent read-modify-write.

  This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.

• value (::Integer) — Optional. Used to perform a consistent read-modify-write.

  This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.

• (::Integer) — Optional. Used to perform a consistent read-modify-write.

  This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.