Class: Google::Apis::DataprocV1beta2::WorkflowTemplate

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

Overview

A Dataproc workflow template resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ WorkflowTemplate

Returns a new instance of WorkflowTemplate.



3370
3371
3372
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3370

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) 


3305
3306
3307
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3305

def create_time
  @create_time
end

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

Returns:

  • (String) 


3312
3313
3314
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3312

def id
  @id
end

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

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

Returns:



3317
3318
3319
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3317

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


3327
3328
3329
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3327

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) 


3339
3340
3341
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3339

def name
  @name
end

#parameters ⇒ Array<Google::Apis::DataprocV1beta2::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:



3345
3346
3347
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3345

def parameters
  @parameters
end

#placement ⇒ Google::Apis::DataprocV1beta2::WorkflowTemplatePlacement

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

Returns:



3351
3352
3353
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3351

def placement
  @placement
end

#update_time ⇒ String

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

Returns:

  • (String) 


3356
3357
3358
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3356

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) 


3368
3369
3370
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3368

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3375

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