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

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

Overview

Genomics API

Upload, process, query, and search 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

#initialize ⇒ GenomicsService

Returns a new instance of GenomicsService



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

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



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

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::GenomicsV2alpha1::CancelOperationRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



111
112
113
114
115
116
117
118
119
120
121
 
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 111

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.

Parameters:

  • id (String) —

    The worker id, assigned when it was created.

  • check_in_request_object (Google::Apis::GenomicsV2alpha1::CheckInRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



240
241
242
243
244
245
246
247
248
249
250
 
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 240

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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 145

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.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) —

    A string for filtering Operations. In v2alpha1, the following filter fields are supported:

    • createTime: The time this job was created
    • events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred.
    • error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code.
    • labels.key or labels."key with space" where key is a label key. In v1 and v1alpha2, the following filter fields are supported:
    • projectId: Required. Corresponds to OperationMetadata.projectId.
    • createTime: The time this job was created, in seconds from the epoch. Can use >= and/or <= operators.
    • status: Can be RUNNING, SUCCESS, FAILURE, or CANCELED. Only one status may be specified.
    • labels.key where key is a label key. Examples:
    • projectId = my-project AND createTime >= 1432140000
    • projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING
    • projectId = my-project AND labels.color = *
    • projectId = my-project AND labels.color = red
  • page_size (Fixnum) —

    The maximum number of results to return. If unspecified, defaults to

    1. The maximum value is 2048.
  • page_token (String) —

    The standard list page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 205

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: In order to use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Genomics API is first enabled, but if you delete this permission, or if you have already enabled the Genomics API prior to the launch of the v2alpha1 API, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions.

Parameters:

  • run_pipeline_request_object (Google::Apis::GenomicsV2alpha1::RunPipelineRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



76
77
78
79
80
81
82
83
84
85
 
# File 'generated/google/apis/genomics_v2alpha1/service.rb', line 76

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