Class: Google::Apis::GenomicsV2alpha1::GenomicsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/genomics_v2alpha1/service.rb

Overview

Genomics API

Uploads, processes, queries, and searches Genomics data in the cloud.

Examples:

require 'google/apis/genomics_v2alpha1'

Genomics = Google::Apis::GenomicsV2alpha1 # Alias the module
service = Genomics::GenomicsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeGenomicsService


45
46
47
48
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 45

def initialize
  super('https://genomics.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV2alpha1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission:

  • genomics.operations.cancel

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


119
120
121
122
123
124
125
126
127
128
129
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 119

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2alpha1/{+name}:cancel', options)
  command.request_representation = Google::Apis::GenomicsV2alpha1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::GenomicsV2alpha1::Empty::Representation
  command.response_class = Google::Apis::GenomicsV2alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_worker_in(id, check_in_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV2alpha1::CheckInResponse

The worker uses this method to retrieve the assigned operation and provide periodic status updates.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


256
257
258
259
260
261
262
263
264
265
266
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 256

def check_worker_in(id, check_in_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2alpha1/workers/{id}:checkIn', options)
  command.request_representation = Google::Apis::GenomicsV2alpha1::CheckInRequest::Representation
  command.request_object = check_in_request_object
  command.response_representation = Google::Apis::GenomicsV2alpha1::CheckInResponse::Representation
  command.response_class = Google::Apis::GenomicsV2alpha1::CheckInResponse
  command.params['id'] = id unless id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV2alpha1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following Google IAM permission:

  • genomics.operations.get

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


156
157
158
159
160
161
162
163
164
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 156

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::GenomicsV2alpha1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV2alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV2alpha1::ListOperationsResponse

Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission:

  • genomics.operations.list

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


221
222
223
224
225
226
227
228
229
230
231
232
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 221

def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2alpha1/{+name}', options)
  command.response_representation = Google::Apis::GenomicsV2alpha1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::GenomicsV2alpha1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#run_pipeline(run_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GenomicsV2alpha1::Operation

Runs a pipeline. Note: Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following Google IAM permission:

  • genomics.operations.create

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


79
80
81
82
83
84
85
86
87
88
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 79

def run_pipeline(run_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2alpha1/pipelines:run', options)
  command.request_representation = Google::Apis::GenomicsV2alpha1::RunPipelineRequest::Representation
  command.request_object = run_pipeline_request_object
  command.response_representation = Google::Apis::GenomicsV2alpha1::Operation::Representation
  command.response_class = Google::Apis::GenomicsV2alpha1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end