Class: Google::Apis::DataflowV1b3::LaunchTemplateParameters

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

Overview

Parameters to provide to the template being launched. Note that the metadata in the pipeline code determines which runtime parameters are valid.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LaunchTemplateParameters

Returns a new instance of LaunchTemplateParameters.



2823
2824
2825
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2823

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

Instance Attribute Details

#environmentGoogle::Apis::DataflowV1b3::RuntimeEnvironment

The environment values to set at runtime. Corresponds to the JSON property environment



2797
2798
2799
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2797

def environment
  @environment
end

#job_nameString

Required. The job name to use for the created job. The name must match the regular expression [a-z]([-a-z0-9]0,1022[a-z0-9])? Corresponds to the JSON property jobName

Returns:

  • (String)


2803
2804
2805
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2803

def job_name
  @job_name
end

#parametersHash<String,String>

The runtime parameters to pass to the job. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,String>)


2808
2809
2810
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2808

def parameters
  @parameters
end

#transform_name_mappingHash<String,String>

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Corresponds to the JSON property transformNameMapping

Returns:

  • (Hash<String,String>)


2814
2815
2816
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2814

def transform_name_mapping
  @transform_name_mapping
end

#updateBoolean Also known as: update?

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state. Corresponds to the JSON property update

Returns:

  • (Boolean)


2820
2821
2822
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2820

def update
  @update
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2828
2829
2830
2831
2832
2833
2834
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2828

def update!(**args)
  @environment = args[:environment] if args.key?(:environment)
  @job_name = args[:job_name] if args.key?(:job_name)
  @parameters = args[:parameters] if args.key?(:parameters)
  @transform_name_mapping = args[:transform_name_mapping] if args.key?(:transform_name_mapping)
  @update = args[:update] if args.key?(:update)
end