Class: Google::Apis::DataprocV1::WorkflowTemplate

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataproc_v1/classes.rb,
lib/google/apis/dataproc_v1/representations.rb,
lib/google/apis/dataproc_v1/representations.rb

Overview

A Dataproc workflow template resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkflowTemplate

Returns a new instance of WorkflowTemplate.



5470
5471
5472
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5470

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The time template was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


5397
5398
5399
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5397

def create_time
  @create_time
end

#dag_timeout ⇒ String

Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/ docs/proto3#json)). 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. Corresponds to the JSON property dagTimeout

Returns:

  • (String) 


5408
5409
5410
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5408

def dag_timeout
  @dag_timeout
end

#id ⇒ String

Corresponds to the JSON property id

Returns:

  • (String) 


5413
5414
5415
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5413

def id
  @id
end

#jobs ⇒ Array<Google::Apis::DataprocV1::OrderedJob>

Required. The Directed Acyclic Graph of Jobs to submit. Corresponds to the JSON property jobs

Returns:



5418
5419
5420
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5418

def jobs
  @jobs
end

#labels ⇒ 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 (https:// www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/ rfc/rfc1035.txt).No more than 32 labels can be associated with a template. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


5428
5429
5430
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5428

def labels
  @labels
end

#name ⇒ 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 Corresponds to the JSON property name

Returns:

  • (String) 


5439
5440
5441
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5439

def name
  @name
end

#parameters ⇒ Array<Google::Apis::DataprocV1::TemplateParameter>

Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. Corresponds to the JSON property parameters

Returns:



5445
5446
5447
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5445

def parameters
  @parameters
end

#placement ⇒ Google::Apis::DataprocV1::WorkflowTemplatePlacement

Specifies workflow execution target.Either managed_cluster or cluster_selector is required. Corresponds to the JSON property placement

Returns:



5451
5452
5453
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5451

def placement
  @placement
end

#update_time ⇒ String

Output only. The time template was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5456
5457
5458
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5456

def update_time
  @update_time
end

#version ⇒ Fixnum

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. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


5468
5469
5470
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5468

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 5475

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dag_timeout = args[:dag_timeout] if args.key?(:dag_timeout)
  @id = args[:id] if args.key?(:id)
  @jobs = args[:jobs] if args.key?(:jobs)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parameters = args[:parameters] if args.key?(:parameters)
  @placement = args[:placement] if args.key?(:placement)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version = args[:version] if args.key?(:version)
end