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



3231
3232
3233
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3231

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) 


3171
3172
3173
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3171

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) 


3178
3179
3180
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3178

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:



3183
3184
3185
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3183

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


3193
3194
3195
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3193

def labels
  @labels
end

#name ⇒ String

Output only. The "resource name" of the template, as described in https:// cloud.google.com/apis/design/resource_names of the form projects/project_id/ regions/region/workflowTemplates/template_id Corresponds to the JSON property name

Returns:

  • (String) 


3200
3201
3202
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3200

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:



3206
3207
3208
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3206

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:



3212
3213
3214
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3212

def placement
  @placement
end

#update_time ⇒ String

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

Returns:

  • (String) 


3217
3218
3219
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3217

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) 


3229
3230
3231
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3229

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
 
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3236

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