Class: Google::Apis::GenomicsV1alpha2::Pipeline

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

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

Returns a new instance of Pipeline



812
813
814
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 812

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

Instance Attribute Details

#description ⇒ String

User-specified description. Corresponds to the JSON property description

Returns:

  • (String) 


769
770
771
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 769

def description
  @description
end

#docker ⇒ Google::Apis::GenomicsV1alpha2::DockerExecutor

The Docker execuctor specification. Corresponds to the JSON property docker

Returns:



774
775
776
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 774

def docker
  @docker
end

#input_parameters ⇒ Array<Google::Apis::GenomicsV1alpha2::PipelineParameter>

Input parameters of the pipeline. Corresponds to the JSON property inputParameters

Returns:



779
780
781
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 779

def input_parameters
  @input_parameters
end

#name ⇒ String

Required. A user specified pipeline name that does not have to be unique. This name can be used for filtering Pipelines in ListPipelines. Corresponds to the JSON property name

Returns:

  • (String) 


785
786
787
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 785

def name
  @name
end

#output_parameters ⇒ Array<Google::Apis::GenomicsV1alpha2::PipelineParameter>

Output parameters of the pipeline. Corresponds to the JSON property outputParameters

Returns:



790
791
792
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 790

def output_parameters
  @output_parameters
end

#pipeline_id ⇒ String

Unique pipeline id that is generated by the service when CreatePipeline is called. Cannot be specified in the Pipeline used in the CreatePipelineRequest, and will be populated in the response to CreatePipeline and all subsequent Get and List calls. Indicates that the service has registered this pipeline. Corresponds to the JSON property pipelineId

Returns:

  • (String) 


799
800
801
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 799

def pipeline_id
  @pipeline_id
end

#project_id ⇒ String

Required. The project in which to create the pipeline. The caller must have WRITE access. Corresponds to the JSON property projectId

Returns:

  • (String) 


805
806
807
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 805

def project_id
  @project_id
end

#resources ⇒ Google::Apis::GenomicsV1alpha2::PipelineResources

The system resources for the pipeline run. Corresponds to the JSON property resources

Returns:



810
811
812
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 810

def resources
  @resources
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



817
818
819
820
821
822
823
824
825
826
 
# File 'generated/google/apis/genomics_v1alpha2/classes.rb', line 817

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @docker = args[:docker] if args.key?(:docker)
  @input_parameters = args[:input_parameters] if args.key?(:input_parameters)
  @name = args[:name] if args.key?(:name)
  @output_parameters = args[:output_parameters] if args.key?(:output_parameters)
  @pipeline_id = args[:pipeline_id] if args.key?(:pipeline_id)
  @project_id = args[:project_id] if args.key?(:project_id)
  @resources = args[:resources] if args.key?(:resources)
end