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



3255
3256
3257
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3255

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


3190
3191
3192
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3190

def create_time
  @create_time
end

#idString

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)


3197
3198
3199
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3197

def id
  @id
end

#jobsArray<Google::Apis::DataprocV1beta2::OrderedJob>

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



3202
3203
3204
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3202

def jobs
  @jobs
end

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


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

def labels
  @labels
end

#nameString

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)


3224
3225
3226
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3224

def name
  @name
end

#parametersArray<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



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

def parameters
  @parameters
end

#placementGoogle::Apis::DataprocV1beta2::WorkflowTemplatePlacement

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



3236
3237
3238
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3236

def placement
  @placement
end

#update_timeString

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

Returns:

  • (String)


3241
3242
3243
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3241

def update_time
  @update_time
end

#versionFixnum

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)


3253
3254
3255
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3253

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
# File 'generated/google/apis/dataproc_v1beta2/classes.rb', line 3260

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