1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module GenomicsV2alpha1
# Genomics API
#
# Uploads, processes, queries, and searches Genomics data in the cloud.
#
# @example
# require 'google/apis/genomics_v2alpha1'
#
# Genomics = Google::Apis::GenomicsV2alpha1 # Alias the module
# service = Genomics::GenomicsService.new
#
# @see https://cloud.google.com/genomics
class GenomicsService < Google::Apis::Core::BaseService
# @return [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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
def initialize
super('https://genomics.googleapis.com/', '')
@batch_path = 'batch'
end
# Runs a pipeline. The returned Operation's metadata field will contain a google.
# genomics.v2alpha1.Metadata object describing the status of the pipeline
# execution. The [response] field will contain a google.genomics.v2alpha1.
# RunPipelineResponse object if the pipeline completes successfully. **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](https://cloud.google.com/iam/
# ) permission: * `genomics.operations.create` [1]: /genomics/gsa
# @param [Google::Apis::GenomicsV2alpha1::RunPipelineRequest] run_pipeline_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GenomicsV2alpha1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GenomicsV2alpha1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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](https://cloud.google.com/iam)
# permission: * `genomics.operations.cancel`
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::GenomicsV2alpha1::CancelOperationRequest] cancel_operation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GenomicsV2alpha1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GenomicsV2alpha1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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](https://cloud.google.com/iam)
# permission: * `genomics.operations.get`
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GenomicsV2alpha1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GenomicsV2alpha1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists operations that match the specified filter in the request. Authorization
# requires the following [Google IAM](https://cloud.google.com/iam) permission: *
# `genomics.operations.list`
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# 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. * done: If the pipeline is running, this value is
# false. Once the pipeline finishes, the value is true. 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](http://en.wikipedia.org/wiki/Unix_time). 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`
# @param [Fixnum] page_size
# The maximum number of results to return. The maximum value is 256.
# @param [String] page_token
# The standard list page token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GenomicsV2alpha1::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GenomicsV2alpha1::ListOperationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# The worker uses this method to retrieve the assigned operation and provide
# periodic status updates.
# @param [String] id
# The VM identity token for authenticating the VM instance. https://cloud.google.
# com/compute/docs/instances/verifying-instance-identity
# @param [Google::Apis::GenomicsV2alpha1::CheckInRequest] check_in_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GenomicsV2alpha1::CheckInResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GenomicsV2alpha1::CheckInResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def check_project_worker_in(id, check_in_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2alpha1/{+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
# The worker uses this method to retrieve the assigned operation and provide
# periodic status updates.
# @param [String] id
# The VM identity token for authenticating the VM instance. https://cloud.google.
# com/compute/docs/instances/verifying-instance-identity
# @param [Google::Apis::GenomicsV2alpha1::CheckInRequest] check_in_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::GenomicsV2alpha1::CheckInResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::GenomicsV2alpha1::CheckInResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|
