Class: Google::Apis::GenomicsV1alpha2::RunPipelineRequest

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

Overview

The request to run a pipeline. If pipelineId is specified, it refers to a saved pipeline created with CreatePipeline and set as the pipelineId of the returned Pipeline object. If ephemeralPipeline is specified, that pipeline is run once with the given args and not saved. It is an error to specify both pipelineId and ephemeralPipeline. pipelineArgs must be specified.

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

Returns a new instance of RunPipelineRequest



1220
1221
1222
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 1220

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

Instance Attribute Details

#ephemeral_pipelineGoogle::Apis::GenomicsV1alpha2::Pipeline

The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the create method and then later run with the run method, or a pipeline can be defined and run all at once with the run method. Corresponds to the JSON property ephemeralPipeline



1208
1209
1210
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 1208

def ephemeral_pipeline
  @ephemeral_pipeline
end

#pipeline_argsGoogle::Apis::GenomicsV1alpha2::RunPipelineArgs

The pipeline run arguments. Corresponds to the JSON property pipelineArgs



1213
1214
1215
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 1213

def pipeline_args
  @pipeline_args
end

#pipeline_idString

The already created pipeline to run. Corresponds to the JSON property pipelineId

Returns:

  • (String)


1218
1219
1220
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 1218

def pipeline_id
  @pipeline_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1225
1226
1227
1228
1229
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 1225

def update!(**args)
  @ephemeral_pipeline = args[:ephemeral_pipeline] if args.key?(:ephemeral_pipeline)
  @pipeline_args = args[:pipeline_args] if args.key?(:pipeline_args)
  @pipeline_id = args[:pipeline_id] if args.key?(:pipeline_id)
end