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.



6515
6516
6517
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6515

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) 


6437
6438
6439
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6437

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) 


6448
6449
6450
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6448

def dag_timeout
  @dag_timeout
end

#encryption_config ⇒ Google::Apis::DataprocV1::GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig

Encryption settings for encrypting workflow template job arguments. Corresponds to the JSON property encryptionConfig

Returns:



6453
6454
6455
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6453

def encryption_config
  @encryption_config
end

#id ⇒ String

Corresponds to the JSON property id

Returns:

  • (String) 


6458
6459
6460
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6458

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:



6463
6464
6465
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6463

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>) 


6473
6474
6475
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6473

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) 


6484
6485
6486
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6484

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:



6490
6491
6492
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6490

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:



6496
6497
6498
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6496

def placement
  @placement
end

#update_time ⇒ String

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

Returns:

  • (String) 


6501
6502
6503
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6501

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) 


6513
6514
6515
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6513

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 6520

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dag_timeout = args[:dag_timeout] if args.key?(:dag_timeout)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
  @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