Class: Google::Cloud::Dataproc::V1beta2::WorkflowTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb

Overview

A Dataproc workflow template resource.

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Google::Protobuf::Timestamp

Returns Output only. The time template was created.

Returns:



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#id ⇒ String

Returns Required. The template id.

The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.

.

Returns:

  • (String) —

    Required. The template id.

    The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.

    .



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#jobs ⇒ Array<Google::Cloud::Dataproc::V1beta2::OrderedJob>

Returns Required. The Directed Acyclic Graph of Jobs to submit.

Returns:



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#labels ⇒ Hash{String => String}

Returns 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:

  • (Hash{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.



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#name ⇒ String

Returns 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}.

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}



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#parameters ⇒ Array<Google::Cloud::Dataproc::V1beta2::TemplateParameter>

Returns Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

Returns:



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#placement ⇒ Google::Cloud::Dataproc::V1beta2::WorkflowTemplatePlacement

Returns Required. WorkflowTemplate scheduling information.

Returns:



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#update_time ⇒ Google::Protobuf::Timestamp

Returns Output only. The time template was last updated.

Returns:



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end

#version ⇒ Integer

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



84
 
# File 'lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb', line 84

class WorkflowTemplate; end