google-apis-genomics_v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,28 @@
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
+ module Google
16
+ module Apis
17
+ module GenomicsV1
18
+ # Version of the google-apis-genomics_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20200804"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,332 @@
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 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module GenomicsV1
24
+
25
+ class CancelOperationRequest
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class ComputeEngine
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class ContainerKilledEvent
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class ContainerStartedEvent
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class ContainerStoppedEvent
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class DelayedEvent
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class Empty
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class Event
68
+ class Representation < Google::Apis::Core::JsonRepresentation; end
69
+
70
+ include Google::Apis::Core::JsonObjectSupport
71
+ end
72
+
73
+ class FailedEvent
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
79
+ class ListOperationsResponse
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class Operation
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
91
+ class OperationEvent
92
+ class Representation < Google::Apis::Core::JsonRepresentation; end
93
+
94
+ include Google::Apis::Core::JsonObjectSupport
95
+ end
96
+
97
+ class OperationMetadata
98
+ class Representation < Google::Apis::Core::JsonRepresentation; end
99
+
100
+ include Google::Apis::Core::JsonObjectSupport
101
+ end
102
+
103
+ class PullStartedEvent
104
+ class Representation < Google::Apis::Core::JsonRepresentation; end
105
+
106
+ include Google::Apis::Core::JsonObjectSupport
107
+ end
108
+
109
+ class PullStoppedEvent
110
+ class Representation < Google::Apis::Core::JsonRepresentation; end
111
+
112
+ include Google::Apis::Core::JsonObjectSupport
113
+ end
114
+
115
+ class RunPipelineResponse
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
121
+ class RuntimeMetadata
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class Status
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
133
+ class UnexpectedExitStatusEvent
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class WorkerAssignedEvent
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
145
+ class WorkerReleasedEvent
146
+ class Representation < Google::Apis::Core::JsonRepresentation; end
147
+
148
+ include Google::Apis::Core::JsonObjectSupport
149
+ end
150
+
151
+ class CancelOperationRequest
152
+ # @private
153
+ class Representation < Google::Apis::Core::JsonRepresentation
154
+ end
155
+ end
156
+
157
+ class ComputeEngine
158
+ # @private
159
+ class Representation < Google::Apis::Core::JsonRepresentation
160
+ collection :disk_names, as: 'diskNames'
161
+ property :instance_name, as: 'instanceName'
162
+ property :machine_type, as: 'machineType'
163
+ property :zone, as: 'zone'
164
+ end
165
+ end
166
+
167
+ class ContainerKilledEvent
168
+ # @private
169
+ class Representation < Google::Apis::Core::JsonRepresentation
170
+ property :action_id, as: 'actionId'
171
+ end
172
+ end
173
+
174
+ class ContainerStartedEvent
175
+ # @private
176
+ class Representation < Google::Apis::Core::JsonRepresentation
177
+ property :action_id, as: 'actionId'
178
+ property :ip_address, as: 'ipAddress'
179
+ hash :port_mappings, as: 'portMappings'
180
+ end
181
+ end
182
+
183
+ class ContainerStoppedEvent
184
+ # @private
185
+ class Representation < Google::Apis::Core::JsonRepresentation
186
+ property :action_id, as: 'actionId'
187
+ property :exit_status, as: 'exitStatus'
188
+ property :stderr, as: 'stderr'
189
+ end
190
+ end
191
+
192
+ class DelayedEvent
193
+ # @private
194
+ class Representation < Google::Apis::Core::JsonRepresentation
195
+ property :cause, as: 'cause'
196
+ collection :metrics, as: 'metrics'
197
+ end
198
+ end
199
+
200
+ class Empty
201
+ # @private
202
+ class Representation < Google::Apis::Core::JsonRepresentation
203
+ end
204
+ end
205
+
206
+ class Event
207
+ # @private
208
+ class Representation < Google::Apis::Core::JsonRepresentation
209
+ property :description, as: 'description'
210
+ hash :details, as: 'details'
211
+ property :timestamp, as: 'timestamp'
212
+ end
213
+ end
214
+
215
+ class FailedEvent
216
+ # @private
217
+ class Representation < Google::Apis::Core::JsonRepresentation
218
+ property :cause, as: 'cause'
219
+ property :code, as: 'code'
220
+ end
221
+ end
222
+
223
+ class ListOperationsResponse
224
+ # @private
225
+ class Representation < Google::Apis::Core::JsonRepresentation
226
+ property :next_page_token, as: 'nextPageToken'
227
+ collection :operations, as: 'operations', class: Google::Apis::GenomicsV1::Operation, decorator: Google::Apis::GenomicsV1::Operation::Representation
228
+
229
+ end
230
+ end
231
+
232
+ class Operation
233
+ # @private
234
+ class Representation < Google::Apis::Core::JsonRepresentation
235
+ property :done, as: 'done'
236
+ property :error, as: 'error', class: Google::Apis::GenomicsV1::Status, decorator: Google::Apis::GenomicsV1::Status::Representation
237
+
238
+ hash :metadata, as: 'metadata'
239
+ property :name, as: 'name'
240
+ hash :response, as: 'response'
241
+ end
242
+ end
243
+
244
+ class OperationEvent
245
+ # @private
246
+ class Representation < Google::Apis::Core::JsonRepresentation
247
+ property :description, as: 'description'
248
+ property :end_time, as: 'endTime'
249
+ property :start_time, as: 'startTime'
250
+ end
251
+ end
252
+
253
+ class OperationMetadata
254
+ # @private
255
+ class Representation < Google::Apis::Core::JsonRepresentation
256
+ property :client_id, as: 'clientId'
257
+ property :create_time, as: 'createTime'
258
+ property :end_time, as: 'endTime'
259
+ collection :events, as: 'events', class: Google::Apis::GenomicsV1::OperationEvent, decorator: Google::Apis::GenomicsV1::OperationEvent::Representation
260
+
261
+ hash :labels, as: 'labels'
262
+ property :project_id, as: 'projectId'
263
+ hash :request, as: 'request'
264
+ hash :runtime_metadata, as: 'runtimeMetadata'
265
+ property :start_time, as: 'startTime'
266
+ end
267
+ end
268
+
269
+ class PullStartedEvent
270
+ # @private
271
+ class Representation < Google::Apis::Core::JsonRepresentation
272
+ property :image_uri, as: 'imageUri'
273
+ end
274
+ end
275
+
276
+ class PullStoppedEvent
277
+ # @private
278
+ class Representation < Google::Apis::Core::JsonRepresentation
279
+ property :image_uri, as: 'imageUri'
280
+ end
281
+ end
282
+
283
+ class RunPipelineResponse
284
+ # @private
285
+ class Representation < Google::Apis::Core::JsonRepresentation
286
+ end
287
+ end
288
+
289
+ class RuntimeMetadata
290
+ # @private
291
+ class Representation < Google::Apis::Core::JsonRepresentation
292
+ property :compute_engine, as: 'computeEngine', class: Google::Apis::GenomicsV1::ComputeEngine, decorator: Google::Apis::GenomicsV1::ComputeEngine::Representation
293
+
294
+ end
295
+ end
296
+
297
+ class Status
298
+ # @private
299
+ class Representation < Google::Apis::Core::JsonRepresentation
300
+ property :code, as: 'code'
301
+ collection :details, as: 'details'
302
+ property :message, as: 'message'
303
+ end
304
+ end
305
+
306
+ class UnexpectedExitStatusEvent
307
+ # @private
308
+ class Representation < Google::Apis::Core::JsonRepresentation
309
+ property :action_id, as: 'actionId'
310
+ property :exit_status, as: 'exitStatus'
311
+ end
312
+ end
313
+
314
+ class WorkerAssignedEvent
315
+ # @private
316
+ class Representation < Google::Apis::Core::JsonRepresentation
317
+ property :instance, as: 'instance'
318
+ property :machine_type, as: 'machineType'
319
+ property :zone, as: 'zone'
320
+ end
321
+ end
322
+
323
+ class WorkerReleasedEvent
324
+ # @private
325
+ class Representation < Google::Apis::Core::JsonRepresentation
326
+ property :instance, as: 'instance'
327
+ property :zone, as: 'zone'
328
+ end
329
+ end
330
+ end
331
+ end
332
+ end
@@ -0,0 +1,189 @@
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 GenomicsV1
23
+ # Genomics API
24
+ #
25
+ # Uploads, processes, queries, and searches Genomics data in the cloud.
26
+ #
27
+ # @example
28
+ # require 'google/apis/genomics_v1'
29
+ #
30
+ # Genomics = Google::Apis::GenomicsV1 # 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_v1',
48
+ client_version: Google::Apis::GenomicsV1::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::GenomicsV1::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::GenomicsV1::Empty] parsed result object
71
+ # @yieldparam err [StandardError] error object if request failed
72
+ #
73
+ # @return [Google::Apis::GenomicsV1::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, 'v1/{+name}:cancel', options)
80
+ command.request_representation = Google::Apis::GenomicsV1::CancelOperationRequest::Representation
81
+ command.request_object = cancel_operation_request_object
82
+ command.response_representation = Google::Apis::GenomicsV1::Empty::Representation
83
+ command.response_class = Google::Apis::GenomicsV1::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::GenomicsV1::Operation] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::GenomicsV1::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, 'v1/{+name}', options)
115
+ command.response_representation = Google::Apis::GenomicsV1::Operation::Representation
116
+ command.response_class = Google::Apis::GenomicsV1::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::GenomicsV1::ListOperationsResponse] parsed result object
160
+ # @yieldparam err [StandardError] error object if request failed
161
+ #
162
+ # @return [Google::Apis::GenomicsV1::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, 'v1/{+name}', options)
169
+ command.response_representation = Google::Apis::GenomicsV1::ListOperationsResponse::Representation
170
+ command.response_class = Google::Apis::GenomicsV1::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
+ protected
181
+
182
+ def apply_command_defaults(command)
183
+ command.query['key'] = key unless key.nil?
184
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
185
+ end
186
+ end
187
+ end
188
+ end
189
+ end