Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::WorkflowTemplate (v0.19.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

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#dag_timeout

def dag_timeout() -> ::Google::Protobuf::Duration
Returns
  • (::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.

#dag_timeout=

def dag_timeout=(value) -> ::Google::Protobuf::Duration
Parameter
  • 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.
Returns
  • (::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.

#id

def id() -> ::String
Returns
  • (::String)

#id=

def id=(value) -> ::String
Parameter
  • value (::String)
Returns
  • (::String)

#jobs

def jobs() -> ::Array<::Google::Cloud::Dataproc::V1::OrderedJob>
Returns

#jobs=

def jobs=(value) -> ::Array<::Google::Cloud::Dataproc::V1::OrderedJob>
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • 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.

Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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}

#parameters

def parameters() -> ::Array<::Google::Cloud::Dataproc::V1::TemplateParameter>
Returns

#parameters=

def parameters=(value) -> ::Array<::Google::Cloud::Dataproc::V1::TemplateParameter>
Parameter
Returns

#placement

def placement() -> ::Google::Cloud::Dataproc::V1::WorkflowTemplatePlacement
Returns

#placement=

def placement=(value) -> ::Google::Cloud::Dataproc::V1::WorkflowTemplatePlacement
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#version

def version() -> ::Integer
Returns
  • (::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.

#version=

def version=(value) -> ::Integer
Parameter
  • 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.

Returns
  • (::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.