google-apis-genomics_v1alpha2 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-genomics_v1alpha2.rb +15 -0
- data/lib/google/apis/genomics_v1alpha2.rb +42 -0
- data/lib/google/apis/genomics_v1alpha2/classes.rb +1377 -0
- data/lib/google/apis/genomics_v1alpha2/gem_version.rb +28 -0
- data/lib/google/apis/genomics_v1alpha2/representations.rb +592 -0
- data/lib/google/apis/genomics_v1alpha2/service.rb +426 -0
- metadata +76 -0
@@ -0,0 +1,426 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module GenomicsV1alpha2
|
23
|
+
# Genomics API
|
24
|
+
#
|
25
|
+
# Uploads, processes, queries, and searches Genomics data in the cloud.
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# require 'google/apis/genomics_v1alpha2'
|
29
|
+
#
|
30
|
+
# Genomics = Google::Apis::GenomicsV1alpha2 # Alias the module
|
31
|
+
# service = Genomics::GenomicsService.new
|
32
|
+
#
|
33
|
+
# @see https://cloud.google.com/genomics
|
34
|
+
class GenomicsService < Google::Apis::Core::BaseService
|
35
|
+
# @return [String]
|
36
|
+
# API key. Your API key identifies your project and provides you with API access,
|
37
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
38
|
+
attr_accessor :key
|
39
|
+
|
40
|
+
# @return [String]
|
41
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
42
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
43
|
+
attr_accessor :quota_user
|
44
|
+
|
45
|
+
def initialize
|
46
|
+
super('https://genomics.googleapis.com/', '',
|
47
|
+
client_name: 'google-apis-genomics_v1alpha2',
|
48
|
+
client_version: Google::Apis::GenomicsV1alpha2::GEM_VERSION)
|
49
|
+
@batch_path = 'batch'
|
50
|
+
end
|
51
|
+
|
52
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
53
|
+
# a best effort to cancel the operation, but success is not guaranteed. Clients
|
54
|
+
# may use Operations.GetOperation or Operations.ListOperations to check whether
|
55
|
+
# the cancellation succeeded or the operation completed despite cancellation.
|
56
|
+
# Authorization requires the following [Google IAM](https://cloud.google.com/iam)
|
57
|
+
# permission: * `genomics.operations.cancel`
|
58
|
+
# @param [String] name
|
59
|
+
# The name of the operation resource to be cancelled.
|
60
|
+
# @param [Google::Apis::GenomicsV1alpha2::CancelOperationRequest] cancel_operation_request_object
|
61
|
+
# @param [String] fields
|
62
|
+
# Selector specifying which fields to include in a partial response.
|
63
|
+
# @param [String] quota_user
|
64
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
65
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
66
|
+
# @param [Google::Apis::RequestOptions] options
|
67
|
+
# Request-specific options
|
68
|
+
#
|
69
|
+
# @yield [result, err] Result & error if block supplied
|
70
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Empty] parsed result object
|
71
|
+
# @yieldparam err [StandardError] error object if request failed
|
72
|
+
#
|
73
|
+
# @return [Google::Apis::GenomicsV1alpha2::Empty]
|
74
|
+
#
|
75
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
76
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
77
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
78
|
+
def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
79
|
+
command = make_simple_command(:post, 'v1alpha2/{+name}:cancel', options)
|
80
|
+
command.request_representation = Google::Apis::GenomicsV1alpha2::CancelOperationRequest::Representation
|
81
|
+
command.request_object = cancel_operation_request_object
|
82
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Empty::Representation
|
83
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Empty
|
84
|
+
command.params['name'] = name unless name.nil?
|
85
|
+
command.query['fields'] = fields unless fields.nil?
|
86
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
87
|
+
execute_or_queue_command(command, &block)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
91
|
+
# to poll the operation result at intervals as recommended by the API service.
|
92
|
+
# Authorization requires the following [Google IAM](https://cloud.google.com/iam)
|
93
|
+
# permission: * `genomics.operations.get`
|
94
|
+
# @param [String] name
|
95
|
+
# The name of the operation resource.
|
96
|
+
# @param [String] fields
|
97
|
+
# Selector specifying which fields to include in a partial response.
|
98
|
+
# @param [String] quota_user
|
99
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
100
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
101
|
+
# @param [Google::Apis::RequestOptions] options
|
102
|
+
# Request-specific options
|
103
|
+
#
|
104
|
+
# @yield [result, err] Result & error if block supplied
|
105
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Operation] parsed result object
|
106
|
+
# @yieldparam err [StandardError] error object if request failed
|
107
|
+
#
|
108
|
+
# @return [Google::Apis::GenomicsV1alpha2::Operation]
|
109
|
+
#
|
110
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
111
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
112
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
113
|
+
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
114
|
+
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
115
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Operation::Representation
|
116
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Operation
|
117
|
+
command.params['name'] = name unless name.nil?
|
118
|
+
command.query['fields'] = fields unless fields.nil?
|
119
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
120
|
+
execute_or_queue_command(command, &block)
|
121
|
+
end
|
122
|
+
|
123
|
+
# Lists operations that match the specified filter in the request. Authorization
|
124
|
+
# requires the following [Google IAM](https://cloud.google.com/iam) permission: *
|
125
|
+
# `genomics.operations.list`
|
126
|
+
# @param [String] name
|
127
|
+
# The name of the operation's parent resource.
|
128
|
+
# @param [String] filter
|
129
|
+
# A string for filtering Operations. In v2alpha1, the following filter fields
|
130
|
+
# are supported: * createTime: The time this job was created * events: The set
|
131
|
+
# of event (names) that have occurred while running the pipeline. The : operator
|
132
|
+
# can be used to determine if a particular event has occurred. * error: If the
|
133
|
+
# pipeline is running, this value is NULL. Once the pipeline finishes, the value
|
134
|
+
# is the standard Google error code. * labels.key or labels."key with space"
|
135
|
+
# where key is a label key. * done: If the pipeline is running, this value is
|
136
|
+
# false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the
|
137
|
+
# following filter fields are supported: * projectId: Required. Corresponds to
|
138
|
+
# OperationMetadata.projectId. * createTime: The time this job was created, in
|
139
|
+
# seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=`
|
140
|
+
# and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `
|
141
|
+
# CANCELED`. Only one status may be specified. * labels.key where key is a label
|
142
|
+
# key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `
|
143
|
+
# projectId = my-project AND createTime >= 1432140000 AND createTime <=
|
144
|
+
# 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *
|
145
|
+
# ` * `projectId = my-project AND labels.color = red`
|
146
|
+
# @param [Fixnum] page_size
|
147
|
+
# The maximum number of results to return. The maximum value is 256.
|
148
|
+
# @param [String] page_token
|
149
|
+
# The standard list page token.
|
150
|
+
# @param [String] fields
|
151
|
+
# Selector specifying which fields to include in a partial response.
|
152
|
+
# @param [String] quota_user
|
153
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
154
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
155
|
+
# @param [Google::Apis::RequestOptions] options
|
156
|
+
# Request-specific options
|
157
|
+
#
|
158
|
+
# @yield [result, err] Result & error if block supplied
|
159
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::ListOperationsResponse] parsed result object
|
160
|
+
# @yieldparam err [StandardError] error object if request failed
|
161
|
+
#
|
162
|
+
# @return [Google::Apis::GenomicsV1alpha2::ListOperationsResponse]
|
163
|
+
#
|
164
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
165
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
166
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
167
|
+
def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
168
|
+
command = make_simple_command(:get, 'v1alpha2/{+name}', options)
|
169
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::ListOperationsResponse::Representation
|
170
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::ListOperationsResponse
|
171
|
+
command.params['name'] = name unless name.nil?
|
172
|
+
command.query['filter'] = filter unless filter.nil?
|
173
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
174
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
175
|
+
command.query['fields'] = fields unless fields.nil?
|
176
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
177
|
+
execute_or_queue_command(command, &block)
|
178
|
+
end
|
179
|
+
|
180
|
+
# Creates a pipeline that can be run later. Create takes a Pipeline that has all
|
181
|
+
# fields other than `pipelineId` populated, and then returns the same pipeline
|
182
|
+
# with `pipelineId` populated. This id can be used to run the pipeline. Caller
|
183
|
+
# must have WRITE permission to the project.
|
184
|
+
# @param [Google::Apis::GenomicsV1alpha2::Pipeline] pipeline_object
|
185
|
+
# @param [String] fields
|
186
|
+
# Selector specifying which fields to include in a partial response.
|
187
|
+
# @param [String] quota_user
|
188
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
189
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
190
|
+
# @param [Google::Apis::RequestOptions] options
|
191
|
+
# Request-specific options
|
192
|
+
#
|
193
|
+
# @yield [result, err] Result & error if block supplied
|
194
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Pipeline] parsed result object
|
195
|
+
# @yieldparam err [StandardError] error object if request failed
|
196
|
+
#
|
197
|
+
# @return [Google::Apis::GenomicsV1alpha2::Pipeline]
|
198
|
+
#
|
199
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
200
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
201
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
202
|
+
def create_pipeline(pipeline_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
203
|
+
command = make_simple_command(:post, 'v1alpha2/pipelines', options)
|
204
|
+
command.request_representation = Google::Apis::GenomicsV1alpha2::Pipeline::Representation
|
205
|
+
command.request_object = pipeline_object
|
206
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Pipeline::Representation
|
207
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Pipeline
|
208
|
+
command.query['fields'] = fields unless fields.nil?
|
209
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
210
|
+
execute_or_queue_command(command, &block)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Deletes a pipeline based on ID. Caller must have WRITE permission to the
|
214
|
+
# project.
|
215
|
+
# @param [String] pipeline_id
|
216
|
+
# Caller must have WRITE access to the project in which this pipeline is defined.
|
217
|
+
# @param [String] fields
|
218
|
+
# Selector specifying which fields to include in a partial response.
|
219
|
+
# @param [String] quota_user
|
220
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
221
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
222
|
+
# @param [Google::Apis::RequestOptions] options
|
223
|
+
# Request-specific options
|
224
|
+
#
|
225
|
+
# @yield [result, err] Result & error if block supplied
|
226
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Empty] parsed result object
|
227
|
+
# @yieldparam err [StandardError] error object if request failed
|
228
|
+
#
|
229
|
+
# @return [Google::Apis::GenomicsV1alpha2::Empty]
|
230
|
+
#
|
231
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
232
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
233
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
234
|
+
def delete_pipeline(pipeline_id, fields: nil, quota_user: nil, options: nil, &block)
|
235
|
+
command = make_simple_command(:delete, 'v1alpha2/pipelines/{pipelineId}', options)
|
236
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Empty::Representation
|
237
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Empty
|
238
|
+
command.params['pipelineId'] = pipeline_id unless pipeline_id.nil?
|
239
|
+
command.query['fields'] = fields unless fields.nil?
|
240
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
241
|
+
execute_or_queue_command(command, &block)
|
242
|
+
end
|
243
|
+
|
244
|
+
# Retrieves a pipeline based on ID. Caller must have READ permission to the
|
245
|
+
# project.
|
246
|
+
# @param [String] pipeline_id
|
247
|
+
# Caller must have READ access to the project in which this pipeline is defined.
|
248
|
+
# @param [String] fields
|
249
|
+
# Selector specifying which fields to include in a partial response.
|
250
|
+
# @param [String] quota_user
|
251
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
252
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
253
|
+
# @param [Google::Apis::RequestOptions] options
|
254
|
+
# Request-specific options
|
255
|
+
#
|
256
|
+
# @yield [result, err] Result & error if block supplied
|
257
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Pipeline] parsed result object
|
258
|
+
# @yieldparam err [StandardError] error object if request failed
|
259
|
+
#
|
260
|
+
# @return [Google::Apis::GenomicsV1alpha2::Pipeline]
|
261
|
+
#
|
262
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
263
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
264
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
265
|
+
def get_pipeline(pipeline_id, fields: nil, quota_user: nil, options: nil, &block)
|
266
|
+
command = make_simple_command(:get, 'v1alpha2/pipelines/{pipelineId}', options)
|
267
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Pipeline::Representation
|
268
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Pipeline
|
269
|
+
command.params['pipelineId'] = pipeline_id unless pipeline_id.nil?
|
270
|
+
command.query['fields'] = fields unless fields.nil?
|
271
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
272
|
+
execute_or_queue_command(command, &block)
|
273
|
+
end
|
274
|
+
|
275
|
+
# Gets controller configuration information. Should only be called by VMs
|
276
|
+
# created by the Pipelines Service and not by end users.
|
277
|
+
# @param [String] operation_id
|
278
|
+
# The operation to retrieve controller configuration for.
|
279
|
+
# @param [Fixnum] validation_token
|
280
|
+
# @param [String] fields
|
281
|
+
# Selector specifying which fields to include in a partial response.
|
282
|
+
# @param [String] quota_user
|
283
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
284
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
285
|
+
# @param [Google::Apis::RequestOptions] options
|
286
|
+
# Request-specific options
|
287
|
+
#
|
288
|
+
# @yield [result, err] Result & error if block supplied
|
289
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::ControllerConfig] parsed result object
|
290
|
+
# @yieldparam err [StandardError] error object if request failed
|
291
|
+
#
|
292
|
+
# @return [Google::Apis::GenomicsV1alpha2::ControllerConfig]
|
293
|
+
#
|
294
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
295
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
296
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
297
|
+
def get_pipeline_controller_config(operation_id: nil, validation_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
298
|
+
command = make_simple_command(:get, 'v1alpha2/pipelines:getControllerConfig', options)
|
299
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::ControllerConfig::Representation
|
300
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::ControllerConfig
|
301
|
+
command.query['operationId'] = operation_id unless operation_id.nil?
|
302
|
+
command.query['validationToken'] = validation_token unless validation_token.nil?
|
303
|
+
command.query['fields'] = fields unless fields.nil?
|
304
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
305
|
+
execute_or_queue_command(command, &block)
|
306
|
+
end
|
307
|
+
|
308
|
+
# Lists pipelines. Caller must have READ permission to the project.
|
309
|
+
# @param [String] name_prefix
|
310
|
+
# Pipelines with names that match this prefix should be returned. If unspecified,
|
311
|
+
# all pipelines in the project, up to `pageSize`, will be returned.
|
312
|
+
# @param [Fixnum] page_size
|
313
|
+
# Number of pipelines to return at once. Defaults to 256, and max is 2048.
|
314
|
+
# @param [String] page_token
|
315
|
+
# Token to use to indicate where to start getting results. If unspecified,
|
316
|
+
# returns the first page of results.
|
317
|
+
# @param [String] project_id
|
318
|
+
# Required. The name of the project to search for pipelines. Caller must have
|
319
|
+
# READ access to this project.
|
320
|
+
# @param [String] fields
|
321
|
+
# Selector specifying which fields to include in a partial response.
|
322
|
+
# @param [String] quota_user
|
323
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
324
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
325
|
+
# @param [Google::Apis::RequestOptions] options
|
326
|
+
# Request-specific options
|
327
|
+
#
|
328
|
+
# @yield [result, err] Result & error if block supplied
|
329
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::ListPipelinesResponse] parsed result object
|
330
|
+
# @yieldparam err [StandardError] error object if request failed
|
331
|
+
#
|
332
|
+
# @return [Google::Apis::GenomicsV1alpha2::ListPipelinesResponse]
|
333
|
+
#
|
334
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
335
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
336
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
337
|
+
def list_pipelines(name_prefix: nil, page_size: nil, page_token: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
338
|
+
command = make_simple_command(:get, 'v1alpha2/pipelines', options)
|
339
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::ListPipelinesResponse::Representation
|
340
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::ListPipelinesResponse
|
341
|
+
command.query['namePrefix'] = name_prefix unless name_prefix.nil?
|
342
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
343
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
344
|
+
command.query['projectId'] = project_id unless project_id.nil?
|
345
|
+
command.query['fields'] = fields unless fields.nil?
|
346
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
347
|
+
execute_or_queue_command(command, &block)
|
348
|
+
end
|
349
|
+
|
350
|
+
# Runs a pipeline. If `pipelineId` is specified in the request, then run a saved
|
351
|
+
# pipeline. If `ephemeralPipeline` is specified, then run that pipeline once
|
352
|
+
# without saving a copy. The caller must have READ permission to the project
|
353
|
+
# where the pipeline is stored and WRITE permission to the project where the
|
354
|
+
# pipeline will be run, as VMs will be created and storage will be used. If a
|
355
|
+
# pipeline operation is still running after 6 days, it will be canceled.
|
356
|
+
# @param [Google::Apis::GenomicsV1alpha2::RunPipelineRequest] run_pipeline_request_object
|
357
|
+
# @param [String] fields
|
358
|
+
# Selector specifying which fields to include in a partial response.
|
359
|
+
# @param [String] quota_user
|
360
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
361
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
362
|
+
# @param [Google::Apis::RequestOptions] options
|
363
|
+
# Request-specific options
|
364
|
+
#
|
365
|
+
# @yield [result, err] Result & error if block supplied
|
366
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Operation] parsed result object
|
367
|
+
# @yieldparam err [StandardError] error object if request failed
|
368
|
+
#
|
369
|
+
# @return [Google::Apis::GenomicsV1alpha2::Operation]
|
370
|
+
#
|
371
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
372
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
373
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
374
|
+
def run_pipeline(run_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
375
|
+
command = make_simple_command(:post, 'v1alpha2/pipelines:run', options)
|
376
|
+
command.request_representation = Google::Apis::GenomicsV1alpha2::RunPipelineRequest::Representation
|
377
|
+
command.request_object = run_pipeline_request_object
|
378
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Operation::Representation
|
379
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Operation
|
380
|
+
command.query['fields'] = fields unless fields.nil?
|
381
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
382
|
+
execute_or_queue_command(command, &block)
|
383
|
+
end
|
384
|
+
|
385
|
+
# Sets status of a given operation. Any new timestamps (as determined by
|
386
|
+
# description) are appended to TimestampEvents. Should only be called by VMs
|
387
|
+
# created by the Pipelines Service and not by end users.
|
388
|
+
# @param [Google::Apis::GenomicsV1alpha2::SetOperationStatusRequest] set_operation_status_request_object
|
389
|
+
# @param [String] fields
|
390
|
+
# Selector specifying which fields to include in a partial response.
|
391
|
+
# @param [String] quota_user
|
392
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
393
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
394
|
+
# @param [Google::Apis::RequestOptions] options
|
395
|
+
# Request-specific options
|
396
|
+
#
|
397
|
+
# @yield [result, err] Result & error if block supplied
|
398
|
+
# @yieldparam result [Google::Apis::GenomicsV1alpha2::Empty] parsed result object
|
399
|
+
# @yieldparam err [StandardError] error object if request failed
|
400
|
+
#
|
401
|
+
# @return [Google::Apis::GenomicsV1alpha2::Empty]
|
402
|
+
#
|
403
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
404
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
405
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
406
|
+
def set_pipeline_operation_status(set_operation_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
407
|
+
command = make_simple_command(:put, 'v1alpha2/pipelines:setOperationStatus', options)
|
408
|
+
command.request_representation = Google::Apis::GenomicsV1alpha2::SetOperationStatusRequest::Representation
|
409
|
+
command.request_object = set_operation_status_request_object
|
410
|
+
command.response_representation = Google::Apis::GenomicsV1alpha2::Empty::Representation
|
411
|
+
command.response_class = Google::Apis::GenomicsV1alpha2::Empty
|
412
|
+
command.query['fields'] = fields unless fields.nil?
|
413
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
414
|
+
execute_or_queue_command(command, &block)
|
415
|
+
end
|
416
|
+
|
417
|
+
protected
|
418
|
+
|
419
|
+
def apply_command_defaults(command)
|
420
|
+
command.query['key'] = key unless key.nil?
|
421
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
422
|
+
end
|
423
|
+
end
|
424
|
+
end
|
425
|
+
end
|
426
|
+
end
|
metadata
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-apis-genomics_v1alpha2
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-01-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-apis-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.1'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.1'
|
27
|
+
description: This is the simple REST client for Genomics API V1alpha2. Simple REST
|
28
|
+
clients are Ruby client libraries that provide access to Google services via their
|
29
|
+
HTTP REST API endpoints. These libraries are generated and updated automatically
|
30
|
+
based on the discovery documents published by the service, and they handle most
|
31
|
+
concerns such as authentication, pagination, retry, timeouts, and logging. You can
|
32
|
+
use this client to access the Genomics API, but note that some services may provide
|
33
|
+
a separate modern client that is easier to use.
|
34
|
+
email: googleapis-packages@google.com
|
35
|
+
executables: []
|
36
|
+
extensions: []
|
37
|
+
extra_rdoc_files: []
|
38
|
+
files:
|
39
|
+
- ".yardopts"
|
40
|
+
- CHANGELOG.md
|
41
|
+
- LICENSE.md
|
42
|
+
- OVERVIEW.md
|
43
|
+
- lib/google-apis-genomics_v1alpha2.rb
|
44
|
+
- lib/google/apis/genomics_v1alpha2.rb
|
45
|
+
- lib/google/apis/genomics_v1alpha2/classes.rb
|
46
|
+
- lib/google/apis/genomics_v1alpha2/gem_version.rb
|
47
|
+
- lib/google/apis/genomics_v1alpha2/representations.rb
|
48
|
+
- lib/google/apis/genomics_v1alpha2/service.rb
|
49
|
+
homepage: https://github.com/google/google-api-ruby-client
|
50
|
+
licenses:
|
51
|
+
- Apache-2.0
|
52
|
+
metadata:
|
53
|
+
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
54
|
+
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-genomics_v1alpha2/CHANGELOG.md
|
55
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-genomics_v1alpha2/v0.1.0
|
56
|
+
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-genomics_v1alpha2
|
57
|
+
post_install_message:
|
58
|
+
rdoc_options: []
|
59
|
+
require_paths:
|
60
|
+
- lib
|
61
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
62
|
+
requirements:
|
63
|
+
- - ">="
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: '2.4'
|
66
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
67
|
+
requirements:
|
68
|
+
- - ">="
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: '0'
|
71
|
+
requirements: []
|
72
|
+
rubygems_version: 3.1.4
|
73
|
+
signing_key:
|
74
|
+
specification_version: 4
|
75
|
+
summary: Simple REST client for Genomics API V1alpha2
|
76
|
+
test_files: []
|