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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 38ac0ec15218fd4678f575335ad51debfcf708543328bf80abfa48dc3d8d90aa
|
4
|
+
data.tar.gz: 3339b8481867cfc8f8b534fed7f04412727da1a81d7bbc599d4cf3890e94f6f0
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: fc8a2ae05133effd995a431a7616def33a1f9cfddafe03955617afa2b667a9a4102dc72834a48bd71f909e04a655c100313864e04a390c3fbc7bdc26c22f6b36
|
7
|
+
data.tar.gz: d7340cace9df9dd67062e0b9580a835a1952d6a7f686c5265823f4d73b57a97a14a71bb536219afa272a20a08593a30b5b21022d6bc58c664b2fdef25b779a40
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-genomics_v1alpha2
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/genomics_v1alpha2/*.rb
|
9
|
+
lib/google/apis/genomics_v1alpha2.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1alpha2 of the Genomics API
|
2
|
+
|
3
|
+
This is a simple client library for version V1alpha2 of the Genomics API. It provides:
|
4
|
+
|
5
|
+
* A client object that connects to the HTTP/JSON REST endpoint for the service.
|
6
|
+
* Ruby objects for data structures related to the service.
|
7
|
+
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
|
8
|
+
* Control of retry, pagination, and timeouts.
|
9
|
+
|
10
|
+
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
|
11
|
+
|
12
|
+
## Getting started
|
13
|
+
|
14
|
+
### Before you begin
|
15
|
+
|
16
|
+
There are a few setup steps you need to complete before you can use this library:
|
17
|
+
|
18
|
+
1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
|
19
|
+
2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
|
20
|
+
3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/genomics.googleapis.com) in the console.
|
21
|
+
|
22
|
+
### Installation
|
23
|
+
|
24
|
+
Add this line to your application's Gemfile:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
gem 'google-apis-genomics_v1alpha2', '~> 0.1'
|
28
|
+
```
|
29
|
+
|
30
|
+
And then execute:
|
31
|
+
|
32
|
+
```
|
33
|
+
$ bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
Or install it yourself as:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install google-apis-genomics_v1alpha2
|
40
|
+
```
|
41
|
+
|
42
|
+
### Creating a client object
|
43
|
+
|
44
|
+
Once the gem is installed, you can load the client code and instantiate a client.
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
# Load the client
|
48
|
+
require "google/apis/genomics_v1alpha2"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::GenomicsV1alpha2::GenomicsService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authentication = # ... use the googleauth gem to create credentials
|
55
|
+
```
|
56
|
+
|
57
|
+
See the class reference docs for information on the methods you can call from a client.
|
58
|
+
|
59
|
+
## Documentation
|
60
|
+
|
61
|
+
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
|
+
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
65
|
+
|
66
|
+
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Genomics service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Genomics API, see the {Google::Apis::GenomicsV1alpha2::GenomicsService class reference docs}.
|
69
|
+
|
70
|
+
## Which client should I use?
|
71
|
+
|
72
|
+
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
|
73
|
+
|
74
|
+
This library, `google-apis-genomics_v1alpha2`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://cloud.google.com/genomics) may provide guidance regarding the preferred client library to use.
|
83
|
+
|
84
|
+
## Supported Ruby versions
|
85
|
+
|
86
|
+
This library is supported on Ruby 2.5+.
|
87
|
+
|
88
|
+
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
|
93
|
+
|
94
|
+
## Support
|
95
|
+
|
96
|
+
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
@@ -0,0 +1,15 @@
|
|
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/genomics_v1alpha2"
|
@@ -0,0 +1,42 @@
|
|
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/genomics_v1alpha2/service.rb'
|
16
|
+
require 'google/apis/genomics_v1alpha2/classes.rb'
|
17
|
+
require 'google/apis/genomics_v1alpha2/representations.rb'
|
18
|
+
require 'google/apis/genomics_v1alpha2/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Genomics API
|
23
|
+
#
|
24
|
+
# Uploads, processes, queries, and searches Genomics data in the cloud.
|
25
|
+
#
|
26
|
+
# @see https://cloud.google.com/genomics
|
27
|
+
module GenomicsV1alpha2
|
28
|
+
# Version of the Genomics API this client connects to.
|
29
|
+
# This is NOT the gem version.
|
30
|
+
VERSION = 'V1alpha2'
|
31
|
+
|
32
|
+
# View and manage your data across Google Cloud Platform services
|
33
|
+
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
34
|
+
|
35
|
+
# View and manage your Google Compute Engine resources
|
36
|
+
AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute'
|
37
|
+
|
38
|
+
# View and manage Genomics data
|
39
|
+
AUTH_GENOMICS = 'https://www.googleapis.com/auth/genomics'
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,1377 @@
|
|
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 GenomicsV1alpha2
|
24
|
+
|
25
|
+
# The request message for Operations.CancelOperation.
|
26
|
+
class CancelOperationRequest
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
def initialize(**args)
|
30
|
+
update!(**args)
|
31
|
+
end
|
32
|
+
|
33
|
+
# Update properties of this object
|
34
|
+
def update!(**args)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
# Describes a Compute Engine resource that is being managed by a running
|
39
|
+
# pipeline.
|
40
|
+
class ComputeEngine
|
41
|
+
include Google::Apis::Core::Hashable
|
42
|
+
|
43
|
+
# The names of the disks that were created for this pipeline.
|
44
|
+
# Corresponds to the JSON property `diskNames`
|
45
|
+
# @return [Array<String>]
|
46
|
+
attr_accessor :disk_names
|
47
|
+
|
48
|
+
# The instance on which the operation is running.
|
49
|
+
# Corresponds to the JSON property `instanceName`
|
50
|
+
# @return [String]
|
51
|
+
attr_accessor :instance_name
|
52
|
+
|
53
|
+
# The machine type of the instance.
|
54
|
+
# Corresponds to the JSON property `machineType`
|
55
|
+
# @return [String]
|
56
|
+
attr_accessor :machine_type
|
57
|
+
|
58
|
+
# The availability zone in which the instance resides.
|
59
|
+
# Corresponds to the JSON property `zone`
|
60
|
+
# @return [String]
|
61
|
+
attr_accessor :zone
|
62
|
+
|
63
|
+
def initialize(**args)
|
64
|
+
update!(**args)
|
65
|
+
end
|
66
|
+
|
67
|
+
# Update properties of this object
|
68
|
+
def update!(**args)
|
69
|
+
@disk_names = args[:disk_names] if args.key?(:disk_names)
|
70
|
+
@instance_name = args[:instance_name] if args.key?(:instance_name)
|
71
|
+
@machine_type = args[:machine_type] if args.key?(:machine_type)
|
72
|
+
@zone = args[:zone] if args.key?(:zone)
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
# An event generated when a container is forcibly terminated by the worker.
|
77
|
+
# Currently, this only occurs when the container outlives the timeout specified
|
78
|
+
# by the user.
|
79
|
+
class ContainerKilledEvent
|
80
|
+
include Google::Apis::Core::Hashable
|
81
|
+
|
82
|
+
# The numeric ID of the action that started the container.
|
83
|
+
# Corresponds to the JSON property `actionId`
|
84
|
+
# @return [Fixnum]
|
85
|
+
attr_accessor :action_id
|
86
|
+
|
87
|
+
def initialize(**args)
|
88
|
+
update!(**args)
|
89
|
+
end
|
90
|
+
|
91
|
+
# Update properties of this object
|
92
|
+
def update!(**args)
|
93
|
+
@action_id = args[:action_id] if args.key?(:action_id)
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
# An event generated when a container starts.
|
98
|
+
class ContainerStartedEvent
|
99
|
+
include Google::Apis::Core::Hashable
|
100
|
+
|
101
|
+
# The numeric ID of the action that started this container.
|
102
|
+
# Corresponds to the JSON property `actionId`
|
103
|
+
# @return [Fixnum]
|
104
|
+
attr_accessor :action_id
|
105
|
+
|
106
|
+
# The public IP address that can be used to connect to the container. This field
|
107
|
+
# is only populated when at least one port mapping is present. If the instance
|
108
|
+
# was created with a private address, this field will be empty even if port
|
109
|
+
# mappings exist.
|
110
|
+
# Corresponds to the JSON property `ipAddress`
|
111
|
+
# @return [String]
|
112
|
+
attr_accessor :ip_address
|
113
|
+
|
114
|
+
# The container-to-host port mappings installed for this container. This set
|
115
|
+
# will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well
|
116
|
+
# as any specified in the `Action` definition.
|
117
|
+
# Corresponds to the JSON property `portMappings`
|
118
|
+
# @return [Hash<String,Fixnum>]
|
119
|
+
attr_accessor :port_mappings
|
120
|
+
|
121
|
+
def initialize(**args)
|
122
|
+
update!(**args)
|
123
|
+
end
|
124
|
+
|
125
|
+
# Update properties of this object
|
126
|
+
def update!(**args)
|
127
|
+
@action_id = args[:action_id] if args.key?(:action_id)
|
128
|
+
@ip_address = args[:ip_address] if args.key?(:ip_address)
|
129
|
+
@port_mappings = args[:port_mappings] if args.key?(:port_mappings)
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
# An event generated when a container exits.
|
134
|
+
class ContainerStoppedEvent
|
135
|
+
include Google::Apis::Core::Hashable
|
136
|
+
|
137
|
+
# The numeric ID of the action that started this container.
|
138
|
+
# Corresponds to the JSON property `actionId`
|
139
|
+
# @return [Fixnum]
|
140
|
+
attr_accessor :action_id
|
141
|
+
|
142
|
+
# The exit status of the container.
|
143
|
+
# Corresponds to the JSON property `exitStatus`
|
144
|
+
# @return [Fixnum]
|
145
|
+
attr_accessor :exit_status
|
146
|
+
|
147
|
+
# The tail end of any content written to standard error by the container. If the
|
148
|
+
# content emits large amounts of debugging noise or contains sensitive
|
149
|
+
# information, you can prevent the content from being printed by setting the `
|
150
|
+
# DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end
|
151
|
+
# of the stream is captured here. The entire stream is stored in the `/google/
|
152
|
+
# logs` directory mounted into each action, and can be copied off the machine as
|
153
|
+
# described elsewhere.
|
154
|
+
# Corresponds to the JSON property `stderr`
|
155
|
+
# @return [String]
|
156
|
+
attr_accessor :stderr
|
157
|
+
|
158
|
+
def initialize(**args)
|
159
|
+
update!(**args)
|
160
|
+
end
|
161
|
+
|
162
|
+
# Update properties of this object
|
163
|
+
def update!(**args)
|
164
|
+
@action_id = args[:action_id] if args.key?(:action_id)
|
165
|
+
@exit_status = args[:exit_status] if args.key?(:exit_status)
|
166
|
+
@stderr = args[:stderr] if args.key?(:stderr)
|
167
|
+
end
|
168
|
+
end
|
169
|
+
|
170
|
+
# Stores the information that the controller will fetch from the server in order
|
171
|
+
# to run. Should only be used by VMs created by the Pipelines Service and not by
|
172
|
+
# end users.
|
173
|
+
class ControllerConfig
|
174
|
+
include Google::Apis::Core::Hashable
|
175
|
+
|
176
|
+
#
|
177
|
+
# Corresponds to the JSON property `cmd`
|
178
|
+
# @return [String]
|
179
|
+
attr_accessor :cmd
|
180
|
+
|
181
|
+
#
|
182
|
+
# Corresponds to the JSON property `disks`
|
183
|
+
# @return [Hash<String,String>]
|
184
|
+
attr_accessor :disks
|
185
|
+
|
186
|
+
#
|
187
|
+
# Corresponds to the JSON property `gcsLogPath`
|
188
|
+
# @return [String]
|
189
|
+
attr_accessor :gcs_log_path
|
190
|
+
|
191
|
+
#
|
192
|
+
# Corresponds to the JSON property `gcsSinks`
|
193
|
+
# @return [Hash<String,Google::Apis::GenomicsV1alpha2::RepeatedString>]
|
194
|
+
attr_accessor :gcs_sinks
|
195
|
+
|
196
|
+
#
|
197
|
+
# Corresponds to the JSON property `gcsSources`
|
198
|
+
# @return [Hash<String,Google::Apis::GenomicsV1alpha2::RepeatedString>]
|
199
|
+
attr_accessor :gcs_sources
|
200
|
+
|
201
|
+
#
|
202
|
+
# Corresponds to the JSON property `image`
|
203
|
+
# @return [String]
|
204
|
+
attr_accessor :image
|
205
|
+
|
206
|
+
#
|
207
|
+
# Corresponds to the JSON property `machineType`
|
208
|
+
# @return [String]
|
209
|
+
attr_accessor :machine_type
|
210
|
+
|
211
|
+
#
|
212
|
+
# Corresponds to the JSON property `vars`
|
213
|
+
# @return [Hash<String,String>]
|
214
|
+
attr_accessor :vars
|
215
|
+
|
216
|
+
def initialize(**args)
|
217
|
+
update!(**args)
|
218
|
+
end
|
219
|
+
|
220
|
+
# Update properties of this object
|
221
|
+
def update!(**args)
|
222
|
+
@cmd = args[:cmd] if args.key?(:cmd)
|
223
|
+
@disks = args[:disks] if args.key?(:disks)
|
224
|
+
@gcs_log_path = args[:gcs_log_path] if args.key?(:gcs_log_path)
|
225
|
+
@gcs_sinks = args[:gcs_sinks] if args.key?(:gcs_sinks)
|
226
|
+
@gcs_sources = args[:gcs_sources] if args.key?(:gcs_sources)
|
227
|
+
@image = args[:image] if args.key?(:image)
|
228
|
+
@machine_type = args[:machine_type] if args.key?(:machine_type)
|
229
|
+
@vars = args[:vars] if args.key?(:vars)
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
233
|
+
# An event generated whenever a resource limitation or transient error delays
|
234
|
+
# execution of a pipeline that was otherwise ready to run.
|
235
|
+
class DelayedEvent
|
236
|
+
include Google::Apis::Core::Hashable
|
237
|
+
|
238
|
+
# A textual description of the cause of the delay. The string can change without
|
239
|
+
# notice because it is often generated by another service (such as Compute
|
240
|
+
# Engine).
|
241
|
+
# Corresponds to the JSON property `cause`
|
242
|
+
# @return [String]
|
243
|
+
attr_accessor :cause
|
244
|
+
|
245
|
+
# If the delay was caused by a resource shortage, this field lists the Compute
|
246
|
+
# Engine metrics that are preventing this operation from running (for example, `
|
247
|
+
# CPUS` or `INSTANCES`). If the particular metric is not known, a single `
|
248
|
+
# UNKNOWN` metric will be present.
|
249
|
+
# Corresponds to the JSON property `metrics`
|
250
|
+
# @return [Array<String>]
|
251
|
+
attr_accessor :metrics
|
252
|
+
|
253
|
+
def initialize(**args)
|
254
|
+
update!(**args)
|
255
|
+
end
|
256
|
+
|
257
|
+
# Update properties of this object
|
258
|
+
def update!(**args)
|
259
|
+
@cause = args[:cause] if args.key?(:cause)
|
260
|
+
@metrics = args[:metrics] if args.key?(:metrics)
|
261
|
+
end
|
262
|
+
end
|
263
|
+
|
264
|
+
# A Google Compute Engine disk resource specification.
|
265
|
+
class Disk
|
266
|
+
include Google::Apis::Core::Hashable
|
267
|
+
|
268
|
+
# Deprecated. Disks created by the Pipelines API will be deleted at the end of
|
269
|
+
# the pipeline run, regardless of what this field is set to.
|
270
|
+
# Corresponds to the JSON property `autoDelete`
|
271
|
+
# @return [Boolean]
|
272
|
+
attr_accessor :auto_delete
|
273
|
+
alias_method :auto_delete?, :auto_delete
|
274
|
+
|
275
|
+
# Required at create time and cannot be overridden at run time. Specifies the
|
276
|
+
# path in the docker container where files on this disk should be located. For
|
277
|
+
# example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `
|
278
|
+
# inputs/file.txt`, the docker container can access the data at `/mnt/disk/
|
279
|
+
# inputs/file.txt`.
|
280
|
+
# Corresponds to the JSON property `mountPoint`
|
281
|
+
# @return [String]
|
282
|
+
attr_accessor :mount_point
|
283
|
+
|
284
|
+
# Required. The name of the disk that can be used in the pipeline parameters.
|
285
|
+
# Must be 1 - 63 characters. The name "boot" is reserved for system use.
|
286
|
+
# Corresponds to the JSON property `name`
|
287
|
+
# @return [String]
|
288
|
+
attr_accessor :name
|
289
|
+
|
290
|
+
# Specifies how a sourced-base persistent disk will be mounted. See https://
|
291
|
+
# cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for
|
292
|
+
# more details. Can only be set at create time.
|
293
|
+
# Corresponds to the JSON property `readOnly`
|
294
|
+
# @return [Boolean]
|
295
|
+
attr_accessor :read_only
|
296
|
+
alias_method :read_only?, :read_only
|
297
|
+
|
298
|
+
# The size of the disk. Defaults to 500 (GB). This field is not applicable for
|
299
|
+
# local SSD.
|
300
|
+
# Corresponds to the JSON property `sizeGb`
|
301
|
+
# @return [Fixnum]
|
302
|
+
attr_accessor :size_gb
|
303
|
+
|
304
|
+
# The full or partial URL of the persistent disk to attach. See https://cloud.
|
305
|
+
# google.com/compute/docs/reference/latest/instances#resource and https://cloud.
|
306
|
+
# google.com/compute/docs/disks/persistent-disks#snapshots for more details.
|
307
|
+
# Corresponds to the JSON property `source`
|
308
|
+
# @return [String]
|
309
|
+
attr_accessor :source
|
310
|
+
|
311
|
+
# Required. The type of the disk to create.
|
312
|
+
# Corresponds to the JSON property `type`
|
313
|
+
# @return [String]
|
314
|
+
attr_accessor :type
|
315
|
+
|
316
|
+
def initialize(**args)
|
317
|
+
update!(**args)
|
318
|
+
end
|
319
|
+
|
320
|
+
# Update properties of this object
|
321
|
+
def update!(**args)
|
322
|
+
@auto_delete = args[:auto_delete] if args.key?(:auto_delete)
|
323
|
+
@mount_point = args[:mount_point] if args.key?(:mount_point)
|
324
|
+
@name = args[:name] if args.key?(:name)
|
325
|
+
@read_only = args[:read_only] if args.key?(:read_only)
|
326
|
+
@size_gb = args[:size_gb] if args.key?(:size_gb)
|
327
|
+
@source = args[:source] if args.key?(:source)
|
328
|
+
@type = args[:type] if args.key?(:type)
|
329
|
+
end
|
330
|
+
end
|
331
|
+
|
332
|
+
# The Docker execuctor specification.
|
333
|
+
class DockerExecutor
|
334
|
+
include Google::Apis::Core::Hashable
|
335
|
+
|
336
|
+
# Required. The command or newline delimited script to run. The command string
|
337
|
+
# will be executed within a bash shell. If the command exits with a non-zero
|
338
|
+
# exit code, output parameter de-localization will be skipped and the pipeline
|
339
|
+
# operation's `error` field will be populated. Maximum command string length is
|
340
|
+
# 16384.
|
341
|
+
# Corresponds to the JSON property `cmd`
|
342
|
+
# @return [String]
|
343
|
+
attr_accessor :cmd
|
344
|
+
|
345
|
+
# Required. Image name from either Docker Hub or Google Container Registry.
|
346
|
+
# Users that run pipelines must have READ access to the image.
|
347
|
+
# Corresponds to the JSON property `imageName`
|
348
|
+
# @return [String]
|
349
|
+
attr_accessor :image_name
|
350
|
+
|
351
|
+
def initialize(**args)
|
352
|
+
update!(**args)
|
353
|
+
end
|
354
|
+
|
355
|
+
# Update properties of this object
|
356
|
+
def update!(**args)
|
357
|
+
@cmd = args[:cmd] if args.key?(:cmd)
|
358
|
+
@image_name = args[:image_name] if args.key?(:image_name)
|
359
|
+
end
|
360
|
+
end
|
361
|
+
|
362
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
363
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
364
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
365
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
366
|
+
# `Empty` is empty JSON object ````.
|
367
|
+
class Empty
|
368
|
+
include Google::Apis::Core::Hashable
|
369
|
+
|
370
|
+
def initialize(**args)
|
371
|
+
update!(**args)
|
372
|
+
end
|
373
|
+
|
374
|
+
# Update properties of this object
|
375
|
+
def update!(**args)
|
376
|
+
end
|
377
|
+
end
|
378
|
+
|
379
|
+
# Carries information about events that occur during pipeline execution.
|
380
|
+
class Event
|
381
|
+
include Google::Apis::Core::Hashable
|
382
|
+
|
383
|
+
# A human-readable description of the event. Note that these strings can change
|
384
|
+
# at any time without notice. Any application logic must use the information in
|
385
|
+
# the `details` field.
|
386
|
+
# Corresponds to the JSON property `description`
|
387
|
+
# @return [String]
|
388
|
+
attr_accessor :description
|
389
|
+
|
390
|
+
# Machine-readable details about the event.
|
391
|
+
# Corresponds to the JSON property `details`
|
392
|
+
# @return [Hash<String,Object>]
|
393
|
+
attr_accessor :details
|
394
|
+
|
395
|
+
# The time at which the event occurred.
|
396
|
+
# Corresponds to the JSON property `timestamp`
|
397
|
+
# @return [String]
|
398
|
+
attr_accessor :timestamp
|
399
|
+
|
400
|
+
def initialize(**args)
|
401
|
+
update!(**args)
|
402
|
+
end
|
403
|
+
|
404
|
+
# Update properties of this object
|
405
|
+
def update!(**args)
|
406
|
+
@description = args[:description] if args.key?(:description)
|
407
|
+
@details = args[:details] if args.key?(:details)
|
408
|
+
@timestamp = args[:timestamp] if args.key?(:timestamp)
|
409
|
+
end
|
410
|
+
end
|
411
|
+
|
412
|
+
# An event generated when the execution of a pipeline has failed. Note that
|
413
|
+
# other events can continue to occur after this event.
|
414
|
+
class FailedEvent
|
415
|
+
include Google::Apis::Core::Hashable
|
416
|
+
|
417
|
+
# The human-readable description of the cause of the failure.
|
418
|
+
# Corresponds to the JSON property `cause`
|
419
|
+
# @return [String]
|
420
|
+
attr_accessor :cause
|
421
|
+
|
422
|
+
# The Google standard error code that best describes this failure.
|
423
|
+
# Corresponds to the JSON property `code`
|
424
|
+
# @return [String]
|
425
|
+
attr_accessor :code
|
426
|
+
|
427
|
+
def initialize(**args)
|
428
|
+
update!(**args)
|
429
|
+
end
|
430
|
+
|
431
|
+
# Update properties of this object
|
432
|
+
def update!(**args)
|
433
|
+
@cause = args[:cause] if args.key?(:cause)
|
434
|
+
@code = args[:code] if args.key?(:code)
|
435
|
+
end
|
436
|
+
end
|
437
|
+
|
438
|
+
# The response message for Operations.ListOperations.
|
439
|
+
class ListOperationsResponse
|
440
|
+
include Google::Apis::Core::Hashable
|
441
|
+
|
442
|
+
# The standard List next-page token.
|
443
|
+
# Corresponds to the JSON property `nextPageToken`
|
444
|
+
# @return [String]
|
445
|
+
attr_accessor :next_page_token
|
446
|
+
|
447
|
+
# A list of operations that matches the specified filter in the request.
|
448
|
+
# Corresponds to the JSON property `operations`
|
449
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::Operation>]
|
450
|
+
attr_accessor :operations
|
451
|
+
|
452
|
+
def initialize(**args)
|
453
|
+
update!(**args)
|
454
|
+
end
|
455
|
+
|
456
|
+
# Update properties of this object
|
457
|
+
def update!(**args)
|
458
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
459
|
+
@operations = args[:operations] if args.key?(:operations)
|
460
|
+
end
|
461
|
+
end
|
462
|
+
|
463
|
+
# The response of ListPipelines. Contains at most `pageSize` pipelines. If it
|
464
|
+
# contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken`
|
465
|
+
# will be populated and should be used as the `pageToken` argument to a
|
466
|
+
# subsequent ListPipelines request.
|
467
|
+
class ListPipelinesResponse
|
468
|
+
include Google::Apis::Core::Hashable
|
469
|
+
|
470
|
+
# The token to use to get the next page of results.
|
471
|
+
# Corresponds to the JSON property `nextPageToken`
|
472
|
+
# @return [String]
|
473
|
+
attr_accessor :next_page_token
|
474
|
+
|
475
|
+
# The matched pipelines.
|
476
|
+
# Corresponds to the JSON property `pipelines`
|
477
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::Pipeline>]
|
478
|
+
attr_accessor :pipelines
|
479
|
+
|
480
|
+
def initialize(**args)
|
481
|
+
update!(**args)
|
482
|
+
end
|
483
|
+
|
484
|
+
# Update properties of this object
|
485
|
+
def update!(**args)
|
486
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
487
|
+
@pipelines = args[:pipelines] if args.key?(:pipelines)
|
488
|
+
end
|
489
|
+
end
|
490
|
+
|
491
|
+
# LocalCopy defines how a remote file should be copied to and from the VM.
|
492
|
+
class LocalCopy
|
493
|
+
include Google::Apis::Core::Hashable
|
494
|
+
|
495
|
+
# Required. The name of the disk where this parameter is located. Can be the
|
496
|
+
# name of one of the disks specified in the Resources field, or "boot", which
|
497
|
+
# represents the Docker instance's boot disk and has a mount point of `/`.
|
498
|
+
# Corresponds to the JSON property `disk`
|
499
|
+
# @return [String]
|
500
|
+
attr_accessor :disk
|
501
|
+
|
502
|
+
# Required. The path within the user's docker container where this input should
|
503
|
+
# be localized to and from, relative to the specified disk's mount point. For
|
504
|
+
# example: file.txt,
|
505
|
+
# Corresponds to the JSON property `path`
|
506
|
+
# @return [String]
|
507
|
+
attr_accessor :path
|
508
|
+
|
509
|
+
def initialize(**args)
|
510
|
+
update!(**args)
|
511
|
+
end
|
512
|
+
|
513
|
+
# Update properties of this object
|
514
|
+
def update!(**args)
|
515
|
+
@disk = args[:disk] if args.key?(:disk)
|
516
|
+
@path = args[:path] if args.key?(:path)
|
517
|
+
end
|
518
|
+
end
|
519
|
+
|
520
|
+
# The logging options for the pipeline run.
|
521
|
+
class LoggingOptions
|
522
|
+
include Google::Apis::Core::Hashable
|
523
|
+
|
524
|
+
# The location in Google Cloud Storage to which the pipeline logs will be copied.
|
525
|
+
# Can be specified as a fully qualified directory path, in which case logs will
|
526
|
+
# be output with a unique identifier as the filename in that directory, or as a
|
527
|
+
# fully specified path, which must end in `.log`, in which case that path will
|
528
|
+
# be used, and the user must ensure that logs are not overwritten. Stdout and
|
529
|
+
# stderr logs from the run are also generated and output as `-stdout.log` and `-
|
530
|
+
# stderr.log`.
|
531
|
+
# Corresponds to the JSON property `gcsPath`
|
532
|
+
# @return [String]
|
533
|
+
attr_accessor :gcs_path
|
534
|
+
|
535
|
+
def initialize(**args)
|
536
|
+
update!(**args)
|
537
|
+
end
|
538
|
+
|
539
|
+
# Update properties of this object
|
540
|
+
def update!(**args)
|
541
|
+
@gcs_path = args[:gcs_path] if args.key?(:gcs_path)
|
542
|
+
end
|
543
|
+
end
|
544
|
+
|
545
|
+
# This resource represents a long-running operation that is the result of a
|
546
|
+
# network API call.
|
547
|
+
class Operation
|
548
|
+
include Google::Apis::Core::Hashable
|
549
|
+
|
550
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
551
|
+
# , the operation is completed, and either `error` or `response` is available.
|
552
|
+
# Corresponds to the JSON property `done`
|
553
|
+
# @return [Boolean]
|
554
|
+
attr_accessor :done
|
555
|
+
alias_method :done?, :done
|
556
|
+
|
557
|
+
# The `Status` type defines a logical error model that is suitable for different
|
558
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
559
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
560
|
+
# data: error code, error message, and error details. You can find out more
|
561
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
562
|
+
# //cloud.google.com/apis/design/errors).
|
563
|
+
# Corresponds to the JSON property `error`
|
564
|
+
# @return [Google::Apis::GenomicsV1alpha2::Status]
|
565
|
+
attr_accessor :error
|
566
|
+
|
567
|
+
# An OperationMetadata or Metadata object. This will always be returned with the
|
568
|
+
# Operation.
|
569
|
+
# Corresponds to the JSON property `metadata`
|
570
|
+
# @return [Hash<String,Object>]
|
571
|
+
attr_accessor :metadata
|
572
|
+
|
573
|
+
# The server-assigned name, which is only unique within the same service that
|
574
|
+
# originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-
|
575
|
+
# qzoWAgEw`
|
576
|
+
# Corresponds to the JSON property `name`
|
577
|
+
# @return [String]
|
578
|
+
attr_accessor :name
|
579
|
+
|
580
|
+
# An Empty object.
|
581
|
+
# Corresponds to the JSON property `response`
|
582
|
+
# @return [Hash<String,Object>]
|
583
|
+
attr_accessor :response
|
584
|
+
|
585
|
+
def initialize(**args)
|
586
|
+
update!(**args)
|
587
|
+
end
|
588
|
+
|
589
|
+
# Update properties of this object
|
590
|
+
def update!(**args)
|
591
|
+
@done = args[:done] if args.key?(:done)
|
592
|
+
@error = args[:error] if args.key?(:error)
|
593
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
594
|
+
@name = args[:name] if args.key?(:name)
|
595
|
+
@response = args[:response] if args.key?(:response)
|
596
|
+
end
|
597
|
+
end
|
598
|
+
|
599
|
+
# An event that occurred during an Operation.
|
600
|
+
class OperationEvent
|
601
|
+
include Google::Apis::Core::Hashable
|
602
|
+
|
603
|
+
# Required description of event.
|
604
|
+
# Corresponds to the JSON property `description`
|
605
|
+
# @return [String]
|
606
|
+
attr_accessor :description
|
607
|
+
|
608
|
+
# Optional time of when event finished. An event can have a start time and no
|
609
|
+
# finish time. If an event has a finish time, there must be a start time.
|
610
|
+
# Corresponds to the JSON property `endTime`
|
611
|
+
# @return [String]
|
612
|
+
attr_accessor :end_time
|
613
|
+
|
614
|
+
# Optional time of when event started.
|
615
|
+
# Corresponds to the JSON property `startTime`
|
616
|
+
# @return [String]
|
617
|
+
attr_accessor :start_time
|
618
|
+
|
619
|
+
def initialize(**args)
|
620
|
+
update!(**args)
|
621
|
+
end
|
622
|
+
|
623
|
+
# Update properties of this object
|
624
|
+
def update!(**args)
|
625
|
+
@description = args[:description] if args.key?(:description)
|
626
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
627
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
628
|
+
end
|
629
|
+
end
|
630
|
+
|
631
|
+
# Metadata describing an Operation.
|
632
|
+
class OperationMetadata
|
633
|
+
include Google::Apis::Core::Hashable
|
634
|
+
|
635
|
+
# This field is deprecated. Use `labels` instead. Optionally provided by the
|
636
|
+
# caller when submitting the request that creates the operation.
|
637
|
+
# Corresponds to the JSON property `clientId`
|
638
|
+
# @return [String]
|
639
|
+
attr_accessor :client_id
|
640
|
+
|
641
|
+
# The time at which the job was submitted to the Genomics service.
|
642
|
+
# Corresponds to the JSON property `createTime`
|
643
|
+
# @return [String]
|
644
|
+
attr_accessor :create_time
|
645
|
+
|
646
|
+
# The time at which the job stopped running.
|
647
|
+
# Corresponds to the JSON property `endTime`
|
648
|
+
# @return [String]
|
649
|
+
attr_accessor :end_time
|
650
|
+
|
651
|
+
# Optional event messages that were generated during the job's execution. This
|
652
|
+
# also contains any warnings that were generated during import or export.
|
653
|
+
# Corresponds to the JSON property `events`
|
654
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::OperationEvent>]
|
655
|
+
attr_accessor :events
|
656
|
+
|
657
|
+
# Optionally provided by the caller when submitting the request that creates the
|
658
|
+
# operation.
|
659
|
+
# Corresponds to the JSON property `labels`
|
660
|
+
# @return [Hash<String,String>]
|
661
|
+
attr_accessor :labels
|
662
|
+
|
663
|
+
# The Google Cloud Project in which the job is scoped.
|
664
|
+
# Corresponds to the JSON property `projectId`
|
665
|
+
# @return [String]
|
666
|
+
attr_accessor :project_id
|
667
|
+
|
668
|
+
# The original request that started the operation. Note that this will be in
|
669
|
+
# current version of the API. If the operation was started with v1beta2 API and
|
670
|
+
# a GetOperation is performed on v1 API, a v1 request will be returned.
|
671
|
+
# Corresponds to the JSON property `request`
|
672
|
+
# @return [Hash<String,Object>]
|
673
|
+
attr_accessor :request
|
674
|
+
|
675
|
+
# Runtime metadata on this Operation.
|
676
|
+
# Corresponds to the JSON property `runtimeMetadata`
|
677
|
+
# @return [Hash<String,Object>]
|
678
|
+
attr_accessor :runtime_metadata
|
679
|
+
|
680
|
+
# The time at which the job began to run.
|
681
|
+
# Corresponds to the JSON property `startTime`
|
682
|
+
# @return [String]
|
683
|
+
attr_accessor :start_time
|
684
|
+
|
685
|
+
def initialize(**args)
|
686
|
+
update!(**args)
|
687
|
+
end
|
688
|
+
|
689
|
+
# Update properties of this object
|
690
|
+
def update!(**args)
|
691
|
+
@client_id = args[:client_id] if args.key?(:client_id)
|
692
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
693
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
694
|
+
@events = args[:events] if args.key?(:events)
|
695
|
+
@labels = args[:labels] if args.key?(:labels)
|
696
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
697
|
+
@request = args[:request] if args.key?(:request)
|
698
|
+
@runtime_metadata = args[:runtime_metadata] if args.key?(:runtime_metadata)
|
699
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
700
|
+
end
|
701
|
+
end
|
702
|
+
|
703
|
+
# The pipeline object. Represents a transformation from a set of input
|
704
|
+
# parameters to a set of output parameters. The transformation is defined as a
|
705
|
+
# docker image and command to run within that image. Each pipeline is run on a
|
706
|
+
# Google Compute Engine VM. A pipeline can be created with the `create` method
|
707
|
+
# and then later run with the `run` method, or a pipeline can be defined and run
|
708
|
+
# all at once with the `run` method.
|
709
|
+
class Pipeline
|
710
|
+
include Google::Apis::Core::Hashable
|
711
|
+
|
712
|
+
# User-specified description.
|
713
|
+
# Corresponds to the JSON property `description`
|
714
|
+
# @return [String]
|
715
|
+
attr_accessor :description
|
716
|
+
|
717
|
+
# The Docker execuctor specification.
|
718
|
+
# Corresponds to the JSON property `docker`
|
719
|
+
# @return [Google::Apis::GenomicsV1alpha2::DockerExecutor]
|
720
|
+
attr_accessor :docker
|
721
|
+
|
722
|
+
# Input parameters of the pipeline.
|
723
|
+
# Corresponds to the JSON property `inputParameters`
|
724
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::PipelineParameter>]
|
725
|
+
attr_accessor :input_parameters
|
726
|
+
|
727
|
+
# Required. A user specified pipeline name that does not have to be unique. This
|
728
|
+
# name can be used for filtering Pipelines in ListPipelines.
|
729
|
+
# Corresponds to the JSON property `name`
|
730
|
+
# @return [String]
|
731
|
+
attr_accessor :name
|
732
|
+
|
733
|
+
# Output parameters of the pipeline.
|
734
|
+
# Corresponds to the JSON property `outputParameters`
|
735
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::PipelineParameter>]
|
736
|
+
attr_accessor :output_parameters
|
737
|
+
|
738
|
+
# Unique pipeline id that is generated by the service when CreatePipeline is
|
739
|
+
# called. Cannot be specified in the Pipeline used in the CreatePipelineRequest,
|
740
|
+
# and will be populated in the response to CreatePipeline and all subsequent Get
|
741
|
+
# and List calls. Indicates that the service has registered this pipeline.
|
742
|
+
# Corresponds to the JSON property `pipelineId`
|
743
|
+
# @return [String]
|
744
|
+
attr_accessor :pipeline_id
|
745
|
+
|
746
|
+
# Required. The project in which to create the pipeline. The caller must have
|
747
|
+
# WRITE access.
|
748
|
+
# Corresponds to the JSON property `projectId`
|
749
|
+
# @return [String]
|
750
|
+
attr_accessor :project_id
|
751
|
+
|
752
|
+
# The system resources for the pipeline run.
|
753
|
+
# Corresponds to the JSON property `resources`
|
754
|
+
# @return [Google::Apis::GenomicsV1alpha2::PipelineResources]
|
755
|
+
attr_accessor :resources
|
756
|
+
|
757
|
+
def initialize(**args)
|
758
|
+
update!(**args)
|
759
|
+
end
|
760
|
+
|
761
|
+
# Update properties of this object
|
762
|
+
def update!(**args)
|
763
|
+
@description = args[:description] if args.key?(:description)
|
764
|
+
@docker = args[:docker] if args.key?(:docker)
|
765
|
+
@input_parameters = args[:input_parameters] if args.key?(:input_parameters)
|
766
|
+
@name = args[:name] if args.key?(:name)
|
767
|
+
@output_parameters = args[:output_parameters] if args.key?(:output_parameters)
|
768
|
+
@pipeline_id = args[:pipeline_id] if args.key?(:pipeline_id)
|
769
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
770
|
+
@resources = args[:resources] if args.key?(:resources)
|
771
|
+
end
|
772
|
+
end
|
773
|
+
|
774
|
+
# Parameters facilitate setting and delivering data into the pipeline's
|
775
|
+
# execution environment. They are defined at create time, with optional defaults,
|
776
|
+
# and can be overridden at run time. If `localCopy` is unset, then the
|
777
|
+
# parameter specifies a string that is passed as-is into the pipeline, as the
|
778
|
+
# value of the environment variable with the given name. A default value can be
|
779
|
+
# optionally specified at create time. The default can be overridden at run time
|
780
|
+
# using the inputs map. If no default is given, a value must be supplied at
|
781
|
+
# runtime. If `localCopy` is defined, then the parameter specifies a data source
|
782
|
+
# or sink, both in Google Cloud Storage and on the Docker container where the
|
783
|
+
# pipeline computation is run. The service account associated with the Pipeline (
|
784
|
+
# by default the project's Compute Engine service account) must have access to
|
785
|
+
# the Google Cloud Storage paths. At run time, the Google Cloud Storage paths
|
786
|
+
# can be overridden if a default was provided at create time, or must be set
|
787
|
+
# otherwise. The pipeline runner should add a key/value pair to either the
|
788
|
+
# inputs or outputs map. The indicated data copies will be carried out before/
|
789
|
+
# after pipeline execution, just as if the corresponding arguments were provided
|
790
|
+
# to `gsutil cp`. For example: Given the following `PipelineParameter`,
|
791
|
+
# specified in the `inputParameters` list: ``` `name: "input_file", localCopy: `
|
792
|
+
# path: "file.txt", disk: "pd1"`` ``` where `disk` is defined in the `
|
793
|
+
# PipelineResources` object as: ``` `name: "pd1", mountPoint: "/mnt/disk/"` ```
|
794
|
+
# We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/
|
795
|
+
# mnt/disk` in the docker container. At runtime, an entry for `input_file` would
|
796
|
+
# be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-
|
797
|
+
# bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil
|
798
|
+
# cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt`
|
799
|
+
# maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:
|
800
|
+
# Google Cloud storage pathLocal path file file glob directory For outputs, the
|
801
|
+
# direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-
|
802
|
+
# bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path
|
803
|
+
# file file file directory - directory must already exist glob directory -
|
804
|
+
# directory will be created if it doesn't exist One restriction due to docker
|
805
|
+
# limitations, is that for outputs that are found on the boot disk, the local
|
806
|
+
# path cannot be a glob and must be a file.
|
807
|
+
class PipelineParameter
|
808
|
+
include Google::Apis::Core::Hashable
|
809
|
+
|
810
|
+
# The default value for this parameter. Can be overridden at runtime. If `
|
811
|
+
# localCopy` is present, then this must be a Google Cloud Storage path beginning
|
812
|
+
# with `gs://`.
|
813
|
+
# Corresponds to the JSON property `defaultValue`
|
814
|
+
# @return [String]
|
815
|
+
attr_accessor :default_value
|
816
|
+
|
817
|
+
# Human-readable description.
|
818
|
+
# Corresponds to the JSON property `description`
|
819
|
+
# @return [String]
|
820
|
+
attr_accessor :description
|
821
|
+
|
822
|
+
# LocalCopy defines how a remote file should be copied to and from the VM.
|
823
|
+
# Corresponds to the JSON property `localCopy`
|
824
|
+
# @return [Google::Apis::GenomicsV1alpha2::LocalCopy]
|
825
|
+
attr_accessor :local_copy
|
826
|
+
|
827
|
+
# Required. Name of the parameter - the pipeline runner uses this string as the
|
828
|
+
# key to the input and output maps in RunPipeline.
|
829
|
+
# Corresponds to the JSON property `name`
|
830
|
+
# @return [String]
|
831
|
+
attr_accessor :name
|
832
|
+
|
833
|
+
def initialize(**args)
|
834
|
+
update!(**args)
|
835
|
+
end
|
836
|
+
|
837
|
+
# Update properties of this object
|
838
|
+
def update!(**args)
|
839
|
+
@default_value = args[:default_value] if args.key?(:default_value)
|
840
|
+
@description = args[:description] if args.key?(:description)
|
841
|
+
@local_copy = args[:local_copy] if args.key?(:local_copy)
|
842
|
+
@name = args[:name] if args.key?(:name)
|
843
|
+
end
|
844
|
+
end
|
845
|
+
|
846
|
+
# The system resources for the pipeline run.
|
847
|
+
class PipelineResources
|
848
|
+
include Google::Apis::Core::Hashable
|
849
|
+
|
850
|
+
# Optional. The number of accelerators of the specified type to attach. By
|
851
|
+
# specifying this parameter, you will download and install the following third-
|
852
|
+
# party software onto your managed Compute Engine instances: NVIDIA® Tesla®
|
853
|
+
# drivers and NVIDIA® CUDA toolkit.
|
854
|
+
# Corresponds to the JSON property `acceleratorCount`
|
855
|
+
# @return [Fixnum]
|
856
|
+
attr_accessor :accelerator_count
|
857
|
+
|
858
|
+
# Optional. The Compute Engine defined accelerator type. By specifying this
|
859
|
+
# parameter, you will download and install the following third-party software
|
860
|
+
# onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA®
|
861
|
+
# CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a
|
862
|
+
# list of available accelerator types.
|
863
|
+
# Corresponds to the JSON property `acceleratorType`
|
864
|
+
# @return [String]
|
865
|
+
attr_accessor :accelerator_type
|
866
|
+
|
867
|
+
# The size of the boot disk. Defaults to 10 (GB).
|
868
|
+
# Corresponds to the JSON property `bootDiskSizeGb`
|
869
|
+
# @return [Fixnum]
|
870
|
+
attr_accessor :boot_disk_size_gb
|
871
|
+
|
872
|
+
# Disks to attach.
|
873
|
+
# Corresponds to the JSON property `disks`
|
874
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::Disk>]
|
875
|
+
attr_accessor :disks
|
876
|
+
|
877
|
+
# The minimum number of cores to use. Defaults to 1.
|
878
|
+
# Corresponds to the JSON property `minimumCpuCores`
|
879
|
+
# @return [Fixnum]
|
880
|
+
attr_accessor :minimum_cpu_cores
|
881
|
+
|
882
|
+
# The minimum amount of RAM to use. Defaults to 3.75 (GB)
|
883
|
+
# Corresponds to the JSON property `minimumRamGb`
|
884
|
+
# @return [Float]
|
885
|
+
attr_accessor :minimum_ram_gb
|
886
|
+
|
887
|
+
# Whether to assign an external IP to the instance. This is an experimental
|
888
|
+
# feature that may go away. Defaults to false. Corresponds to `--no_address`
|
889
|
+
# flag for [gcloud compute instances create] (https://cloud.google.com/sdk/
|
890
|
+
# gcloud/reference/compute/instances/create). In order to use this, must be true
|
891
|
+
# for both create time and run time. Cannot be true at run time if false at
|
892
|
+
# create time. If you need to ssh into a private IP VM for debugging, you can
|
893
|
+
# ssh to a public VM and then ssh into the private VM's Internal IP. If
|
894
|
+
# noAddress is set, this pipeline run may only load docker images from Google
|
895
|
+
# Container Registry and not Docker Hub. Before using this, you must [configure
|
896
|
+
# access to Google services from internal IPs](https://cloud.google.com/compute/
|
897
|
+
# docs/configure-private-google-access#
|
898
|
+
# configuring_access_to_google_services_from_internal_ips).
|
899
|
+
# Corresponds to the JSON property `noAddress`
|
900
|
+
# @return [Boolean]
|
901
|
+
attr_accessor :no_address
|
902
|
+
alias_method :no_address?, :no_address
|
903
|
+
|
904
|
+
# Whether to use preemptible VMs. Defaults to `false`. In order to use this,
|
905
|
+
# must be true for both create time and run time. Cannot be true at run time if
|
906
|
+
# false at create time.
|
907
|
+
# Corresponds to the JSON property `preemptible`
|
908
|
+
# @return [Boolean]
|
909
|
+
attr_accessor :preemptible
|
910
|
+
alias_method :preemptible?, :preemptible
|
911
|
+
|
912
|
+
# List of Google Compute Engine availability zones to which resource creation
|
913
|
+
# will restricted. If empty, any zone may be chosen.
|
914
|
+
# Corresponds to the JSON property `zones`
|
915
|
+
# @return [Array<String>]
|
916
|
+
attr_accessor :zones
|
917
|
+
|
918
|
+
def initialize(**args)
|
919
|
+
update!(**args)
|
920
|
+
end
|
921
|
+
|
922
|
+
# Update properties of this object
|
923
|
+
def update!(**args)
|
924
|
+
@accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count)
|
925
|
+
@accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
|
926
|
+
@boot_disk_size_gb = args[:boot_disk_size_gb] if args.key?(:boot_disk_size_gb)
|
927
|
+
@disks = args[:disks] if args.key?(:disks)
|
928
|
+
@minimum_cpu_cores = args[:minimum_cpu_cores] if args.key?(:minimum_cpu_cores)
|
929
|
+
@minimum_ram_gb = args[:minimum_ram_gb] if args.key?(:minimum_ram_gb)
|
930
|
+
@no_address = args[:no_address] if args.key?(:no_address)
|
931
|
+
@preemptible = args[:preemptible] if args.key?(:preemptible)
|
932
|
+
@zones = args[:zones] if args.key?(:zones)
|
933
|
+
end
|
934
|
+
end
|
935
|
+
|
936
|
+
# An event generated when the worker starts pulling an image.
|
937
|
+
class PullStartedEvent
|
938
|
+
include Google::Apis::Core::Hashable
|
939
|
+
|
940
|
+
# The URI of the image that was pulled.
|
941
|
+
# Corresponds to the JSON property `imageUri`
|
942
|
+
# @return [String]
|
943
|
+
attr_accessor :image_uri
|
944
|
+
|
945
|
+
def initialize(**args)
|
946
|
+
update!(**args)
|
947
|
+
end
|
948
|
+
|
949
|
+
# Update properties of this object
|
950
|
+
def update!(**args)
|
951
|
+
@image_uri = args[:image_uri] if args.key?(:image_uri)
|
952
|
+
end
|
953
|
+
end
|
954
|
+
|
955
|
+
# An event generated when the worker stops pulling an image.
|
956
|
+
class PullStoppedEvent
|
957
|
+
include Google::Apis::Core::Hashable
|
958
|
+
|
959
|
+
# The URI of the image that was pulled.
|
960
|
+
# Corresponds to the JSON property `imageUri`
|
961
|
+
# @return [String]
|
962
|
+
attr_accessor :image_uri
|
963
|
+
|
964
|
+
def initialize(**args)
|
965
|
+
update!(**args)
|
966
|
+
end
|
967
|
+
|
968
|
+
# Update properties of this object
|
969
|
+
def update!(**args)
|
970
|
+
@image_uri = args[:image_uri] if args.key?(:image_uri)
|
971
|
+
end
|
972
|
+
end
|
973
|
+
|
974
|
+
#
|
975
|
+
class RepeatedString
|
976
|
+
include Google::Apis::Core::Hashable
|
977
|
+
|
978
|
+
#
|
979
|
+
# Corresponds to the JSON property `values`
|
980
|
+
# @return [Array<String>]
|
981
|
+
attr_accessor :values
|
982
|
+
|
983
|
+
def initialize(**args)
|
984
|
+
update!(**args)
|
985
|
+
end
|
986
|
+
|
987
|
+
# Update properties of this object
|
988
|
+
def update!(**args)
|
989
|
+
@values = args[:values] if args.key?(:values)
|
990
|
+
end
|
991
|
+
end
|
992
|
+
|
993
|
+
# The pipeline run arguments.
|
994
|
+
class RunPipelineArgs
|
995
|
+
include Google::Apis::Core::Hashable
|
996
|
+
|
997
|
+
# This field is deprecated. Use `labels` instead. Client-specified pipeline
|
998
|
+
# operation identifier.
|
999
|
+
# Corresponds to the JSON property `clientId`
|
1000
|
+
# @return [String]
|
1001
|
+
attr_accessor :client_id
|
1002
|
+
|
1003
|
+
# Pipeline input arguments; keys are defined in the pipeline documentation. All
|
1004
|
+
# input parameters that do not have default values must be specified. If
|
1005
|
+
# parameters with defaults are specified here, the defaults will be overridden.
|
1006
|
+
# Corresponds to the JSON property `inputs`
|
1007
|
+
# @return [Hash<String,String>]
|
1008
|
+
attr_accessor :inputs
|
1009
|
+
|
1010
|
+
# How long to keep the VM up after a failure (for example docker command failed,
|
1011
|
+
# copying input or output files failed, etc). While the VM is up, one can ssh
|
1012
|
+
# into the VM to debug. Default is 0; maximum allowed value is 1 day.
|
1013
|
+
# Corresponds to the JSON property `keepVmAliveOnFailureDuration`
|
1014
|
+
# @return [String]
|
1015
|
+
attr_accessor :keep_vm_alive_on_failure_duration
|
1016
|
+
|
1017
|
+
# Labels to apply to this pipeline run. Labels will also be applied to compute
|
1018
|
+
# resources (VM, disks) created by this pipeline run. When listing operations,
|
1019
|
+
# operations can filtered by labels. Label keys may not be empty; label values
|
1020
|
+
# may be empty. Non-empty labels must be 1-63 characters long, and comply with [
|
1021
|
+
# RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must
|
1022
|
+
# be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-
|
1023
|
+
# z0-9])?` which means the first character must be a lowercase letter, and all
|
1024
|
+
# following characters must be a dash, lowercase letter, or digit, except the
|
1025
|
+
# last character, which cannot be a dash.
|
1026
|
+
# Corresponds to the JSON property `labels`
|
1027
|
+
# @return [Hash<String,String>]
|
1028
|
+
attr_accessor :labels
|
1029
|
+
|
1030
|
+
# The logging options for the pipeline run.
|
1031
|
+
# Corresponds to the JSON property `logging`
|
1032
|
+
# @return [Google::Apis::GenomicsV1alpha2::LoggingOptions]
|
1033
|
+
attr_accessor :logging
|
1034
|
+
|
1035
|
+
# Pipeline output arguments; keys are defined in the pipeline documentation. All
|
1036
|
+
# output parameters of without default values must be specified. If parameters
|
1037
|
+
# with defaults are specified here, the defaults will be overridden.
|
1038
|
+
# Corresponds to the JSON property `outputs`
|
1039
|
+
# @return [Hash<String,String>]
|
1040
|
+
attr_accessor :outputs
|
1041
|
+
|
1042
|
+
# Required. The project in which to run the pipeline. The caller must have
|
1043
|
+
# WRITER access to all Google Cloud services and resources (e.g. Google Compute
|
1044
|
+
# Engine) will be used.
|
1045
|
+
# Corresponds to the JSON property `projectId`
|
1046
|
+
# @return [String]
|
1047
|
+
attr_accessor :project_id
|
1048
|
+
|
1049
|
+
# The system resources for the pipeline run.
|
1050
|
+
# Corresponds to the JSON property `resources`
|
1051
|
+
# @return [Google::Apis::GenomicsV1alpha2::PipelineResources]
|
1052
|
+
attr_accessor :resources
|
1053
|
+
|
1054
|
+
# A Google Cloud Service Account.
|
1055
|
+
# Corresponds to the JSON property `serviceAccount`
|
1056
|
+
# @return [Google::Apis::GenomicsV1alpha2::ServiceAccount]
|
1057
|
+
attr_accessor :service_account
|
1058
|
+
|
1059
|
+
def initialize(**args)
|
1060
|
+
update!(**args)
|
1061
|
+
end
|
1062
|
+
|
1063
|
+
# Update properties of this object
|
1064
|
+
def update!(**args)
|
1065
|
+
@client_id = args[:client_id] if args.key?(:client_id)
|
1066
|
+
@inputs = args[:inputs] if args.key?(:inputs)
|
1067
|
+
@keep_vm_alive_on_failure_duration = args[:keep_vm_alive_on_failure_duration] if args.key?(:keep_vm_alive_on_failure_duration)
|
1068
|
+
@labels = args[:labels] if args.key?(:labels)
|
1069
|
+
@logging = args[:logging] if args.key?(:logging)
|
1070
|
+
@outputs = args[:outputs] if args.key?(:outputs)
|
1071
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
1072
|
+
@resources = args[:resources] if args.key?(:resources)
|
1073
|
+
@service_account = args[:service_account] if args.key?(:service_account)
|
1074
|
+
end
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
# The request to run a pipeline. If `pipelineId` is specified, it refers to a
|
1078
|
+
# saved pipeline created with CreatePipeline and set as the `pipelineId` of the
|
1079
|
+
# returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline
|
1080
|
+
# is run once with the given args and not saved. It is an error to specify both `
|
1081
|
+
# pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.
|
1082
|
+
class RunPipelineRequest
|
1083
|
+
include Google::Apis::Core::Hashable
|
1084
|
+
|
1085
|
+
# The pipeline object. Represents a transformation from a set of input
|
1086
|
+
# parameters to a set of output parameters. The transformation is defined as a
|
1087
|
+
# docker image and command to run within that image. Each pipeline is run on a
|
1088
|
+
# Google Compute Engine VM. A pipeline can be created with the `create` method
|
1089
|
+
# and then later run with the `run` method, or a pipeline can be defined and run
|
1090
|
+
# all at once with the `run` method.
|
1091
|
+
# Corresponds to the JSON property `ephemeralPipeline`
|
1092
|
+
# @return [Google::Apis::GenomicsV1alpha2::Pipeline]
|
1093
|
+
attr_accessor :ephemeral_pipeline
|
1094
|
+
|
1095
|
+
# The pipeline run arguments.
|
1096
|
+
# Corresponds to the JSON property `pipelineArgs`
|
1097
|
+
# @return [Google::Apis::GenomicsV1alpha2::RunPipelineArgs]
|
1098
|
+
attr_accessor :pipeline_args
|
1099
|
+
|
1100
|
+
# The already created pipeline to run.
|
1101
|
+
# Corresponds to the JSON property `pipelineId`
|
1102
|
+
# @return [String]
|
1103
|
+
attr_accessor :pipeline_id
|
1104
|
+
|
1105
|
+
def initialize(**args)
|
1106
|
+
update!(**args)
|
1107
|
+
end
|
1108
|
+
|
1109
|
+
# Update properties of this object
|
1110
|
+
def update!(**args)
|
1111
|
+
@ephemeral_pipeline = args[:ephemeral_pipeline] if args.key?(:ephemeral_pipeline)
|
1112
|
+
@pipeline_args = args[:pipeline_args] if args.key?(:pipeline_args)
|
1113
|
+
@pipeline_id = args[:pipeline_id] if args.key?(:pipeline_id)
|
1114
|
+
end
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
# The response to the RunPipeline method, returned in the operation's result
|
1118
|
+
# field on success.
|
1119
|
+
class RunPipelineResponse
|
1120
|
+
include Google::Apis::Core::Hashable
|
1121
|
+
|
1122
|
+
def initialize(**args)
|
1123
|
+
update!(**args)
|
1124
|
+
end
|
1125
|
+
|
1126
|
+
# Update properties of this object
|
1127
|
+
def update!(**args)
|
1128
|
+
end
|
1129
|
+
end
|
1130
|
+
|
1131
|
+
# Runtime metadata that will be populated in the runtimeMetadata field of the
|
1132
|
+
# Operation associated with a RunPipeline execution.
|
1133
|
+
class RuntimeMetadata
|
1134
|
+
include Google::Apis::Core::Hashable
|
1135
|
+
|
1136
|
+
# Describes a Compute Engine resource that is being managed by a running
|
1137
|
+
# pipeline.
|
1138
|
+
# Corresponds to the JSON property `computeEngine`
|
1139
|
+
# @return [Google::Apis::GenomicsV1alpha2::ComputeEngine]
|
1140
|
+
attr_accessor :compute_engine
|
1141
|
+
|
1142
|
+
def initialize(**args)
|
1143
|
+
update!(**args)
|
1144
|
+
end
|
1145
|
+
|
1146
|
+
# Update properties of this object
|
1147
|
+
def update!(**args)
|
1148
|
+
@compute_engine = args[:compute_engine] if args.key?(:compute_engine)
|
1149
|
+
end
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# A Google Cloud Service Account.
|
1153
|
+
class ServiceAccount
|
1154
|
+
include Google::Apis::Core::Hashable
|
1155
|
+
|
1156
|
+
# Email address of the service account. Defaults to `default`, which uses the
|
1157
|
+
# compute service account associated with the project.
|
1158
|
+
# Corresponds to the JSON property `email`
|
1159
|
+
# @return [String]
|
1160
|
+
attr_accessor :email
|
1161
|
+
|
1162
|
+
# List of scopes to be enabled for this service account on the VM. The following
|
1163
|
+
# scopes are automatically included: * https://www.googleapis.com/auth/compute *
|
1164
|
+
# https://www.googleapis.com/auth/devstorage.full_control * https://www.
|
1165
|
+
# googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write *
|
1166
|
+
# https://www.googleapis.com/auth/monitoring.write
|
1167
|
+
# Corresponds to the JSON property `scopes`
|
1168
|
+
# @return [Array<String>]
|
1169
|
+
attr_accessor :scopes
|
1170
|
+
|
1171
|
+
def initialize(**args)
|
1172
|
+
update!(**args)
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
# Update properties of this object
|
1176
|
+
def update!(**args)
|
1177
|
+
@email = args[:email] if args.key?(:email)
|
1178
|
+
@scopes = args[:scopes] if args.key?(:scopes)
|
1179
|
+
end
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
# Request to set operation status. Should only be used by VMs created by the
|
1183
|
+
# Pipelines Service and not by end users.
|
1184
|
+
class SetOperationStatusRequest
|
1185
|
+
include Google::Apis::Core::Hashable
|
1186
|
+
|
1187
|
+
#
|
1188
|
+
# Corresponds to the JSON property `errorCode`
|
1189
|
+
# @return [String]
|
1190
|
+
attr_accessor :error_code
|
1191
|
+
|
1192
|
+
#
|
1193
|
+
# Corresponds to the JSON property `errorMessage`
|
1194
|
+
# @return [String]
|
1195
|
+
attr_accessor :error_message
|
1196
|
+
|
1197
|
+
#
|
1198
|
+
# Corresponds to the JSON property `operationId`
|
1199
|
+
# @return [String]
|
1200
|
+
attr_accessor :operation_id
|
1201
|
+
|
1202
|
+
#
|
1203
|
+
# Corresponds to the JSON property `timestampEvents`
|
1204
|
+
# @return [Array<Google::Apis::GenomicsV1alpha2::TimestampEvent>]
|
1205
|
+
attr_accessor :timestamp_events
|
1206
|
+
|
1207
|
+
#
|
1208
|
+
# Corresponds to the JSON property `validationToken`
|
1209
|
+
# @return [Fixnum]
|
1210
|
+
attr_accessor :validation_token
|
1211
|
+
|
1212
|
+
def initialize(**args)
|
1213
|
+
update!(**args)
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
# Update properties of this object
|
1217
|
+
def update!(**args)
|
1218
|
+
@error_code = args[:error_code] if args.key?(:error_code)
|
1219
|
+
@error_message = args[:error_message] if args.key?(:error_message)
|
1220
|
+
@operation_id = args[:operation_id] if args.key?(:operation_id)
|
1221
|
+
@timestamp_events = args[:timestamp_events] if args.key?(:timestamp_events)
|
1222
|
+
@validation_token = args[:validation_token] if args.key?(:validation_token)
|
1223
|
+
end
|
1224
|
+
end
|
1225
|
+
|
1226
|
+
# The `Status` type defines a logical error model that is suitable for different
|
1227
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
1228
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
1229
|
+
# data: error code, error message, and error details. You can find out more
|
1230
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
1231
|
+
# //cloud.google.com/apis/design/errors).
|
1232
|
+
class Status
|
1233
|
+
include Google::Apis::Core::Hashable
|
1234
|
+
|
1235
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
1236
|
+
# Corresponds to the JSON property `code`
|
1237
|
+
# @return [Fixnum]
|
1238
|
+
attr_accessor :code
|
1239
|
+
|
1240
|
+
# A list of messages that carry the error details. There is a common set of
|
1241
|
+
# message types for APIs to use.
|
1242
|
+
# Corresponds to the JSON property `details`
|
1243
|
+
# @return [Array<Hash<String,Object>>]
|
1244
|
+
attr_accessor :details
|
1245
|
+
|
1246
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
1247
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
1248
|
+
# field, or localized by the client.
|
1249
|
+
# Corresponds to the JSON property `message`
|
1250
|
+
# @return [String]
|
1251
|
+
attr_accessor :message
|
1252
|
+
|
1253
|
+
def initialize(**args)
|
1254
|
+
update!(**args)
|
1255
|
+
end
|
1256
|
+
|
1257
|
+
# Update properties of this object
|
1258
|
+
def update!(**args)
|
1259
|
+
@code = args[:code] if args.key?(:code)
|
1260
|
+
@details = args[:details] if args.key?(:details)
|
1261
|
+
@message = args[:message] if args.key?(:message)
|
1262
|
+
end
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# Stores the list of events and times they occured for major events in job
|
1266
|
+
# execution.
|
1267
|
+
class TimestampEvent
|
1268
|
+
include Google::Apis::Core::Hashable
|
1269
|
+
|
1270
|
+
# String indicating the type of event
|
1271
|
+
# Corresponds to the JSON property `description`
|
1272
|
+
# @return [String]
|
1273
|
+
attr_accessor :description
|
1274
|
+
|
1275
|
+
# The time this event occured.
|
1276
|
+
# Corresponds to the JSON property `timestamp`
|
1277
|
+
# @return [String]
|
1278
|
+
attr_accessor :timestamp
|
1279
|
+
|
1280
|
+
def initialize(**args)
|
1281
|
+
update!(**args)
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# Update properties of this object
|
1285
|
+
def update!(**args)
|
1286
|
+
@description = args[:description] if args.key?(:description)
|
1287
|
+
@timestamp = args[:timestamp] if args.key?(:timestamp)
|
1288
|
+
end
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# An event generated when the execution of a container results in a non-zero
|
1292
|
+
# exit status that was not otherwise ignored. Execution will continue, but only
|
1293
|
+
# actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will
|
1294
|
+
# be skipped.
|
1295
|
+
class UnexpectedExitStatusEvent
|
1296
|
+
include Google::Apis::Core::Hashable
|
1297
|
+
|
1298
|
+
# The numeric ID of the action that started the container.
|
1299
|
+
# Corresponds to the JSON property `actionId`
|
1300
|
+
# @return [Fixnum]
|
1301
|
+
attr_accessor :action_id
|
1302
|
+
|
1303
|
+
# The exit status of the container.
|
1304
|
+
# Corresponds to the JSON property `exitStatus`
|
1305
|
+
# @return [Fixnum]
|
1306
|
+
attr_accessor :exit_status
|
1307
|
+
|
1308
|
+
def initialize(**args)
|
1309
|
+
update!(**args)
|
1310
|
+
end
|
1311
|
+
|
1312
|
+
# Update properties of this object
|
1313
|
+
def update!(**args)
|
1314
|
+
@action_id = args[:action_id] if args.key?(:action_id)
|
1315
|
+
@exit_status = args[:exit_status] if args.key?(:exit_status)
|
1316
|
+
end
|
1317
|
+
end
|
1318
|
+
|
1319
|
+
# An event generated after a worker VM has been assigned to run the pipeline.
|
1320
|
+
class WorkerAssignedEvent
|
1321
|
+
include Google::Apis::Core::Hashable
|
1322
|
+
|
1323
|
+
# The worker's instance name.
|
1324
|
+
# Corresponds to the JSON property `instance`
|
1325
|
+
# @return [String]
|
1326
|
+
attr_accessor :instance
|
1327
|
+
|
1328
|
+
# The machine type that was assigned for the worker.
|
1329
|
+
# Corresponds to the JSON property `machineType`
|
1330
|
+
# @return [String]
|
1331
|
+
attr_accessor :machine_type
|
1332
|
+
|
1333
|
+
# The zone the worker is running in.
|
1334
|
+
# Corresponds to the JSON property `zone`
|
1335
|
+
# @return [String]
|
1336
|
+
attr_accessor :zone
|
1337
|
+
|
1338
|
+
def initialize(**args)
|
1339
|
+
update!(**args)
|
1340
|
+
end
|
1341
|
+
|
1342
|
+
# Update properties of this object
|
1343
|
+
def update!(**args)
|
1344
|
+
@instance = args[:instance] if args.key?(:instance)
|
1345
|
+
@machine_type = args[:machine_type] if args.key?(:machine_type)
|
1346
|
+
@zone = args[:zone] if args.key?(:zone)
|
1347
|
+
end
|
1348
|
+
end
|
1349
|
+
|
1350
|
+
# An event generated when the worker VM that was assigned to the pipeline has
|
1351
|
+
# been released (deleted).
|
1352
|
+
class WorkerReleasedEvent
|
1353
|
+
include Google::Apis::Core::Hashable
|
1354
|
+
|
1355
|
+
# The worker's instance name.
|
1356
|
+
# Corresponds to the JSON property `instance`
|
1357
|
+
# @return [String]
|
1358
|
+
attr_accessor :instance
|
1359
|
+
|
1360
|
+
# The zone the worker was running in.
|
1361
|
+
# Corresponds to the JSON property `zone`
|
1362
|
+
# @return [String]
|
1363
|
+
attr_accessor :zone
|
1364
|
+
|
1365
|
+
def initialize(**args)
|
1366
|
+
update!(**args)
|
1367
|
+
end
|
1368
|
+
|
1369
|
+
# Update properties of this object
|
1370
|
+
def update!(**args)
|
1371
|
+
@instance = args[:instance] if args.key?(:instance)
|
1372
|
+
@zone = args[:zone] if args.key?(:zone)
|
1373
|
+
end
|
1374
|
+
end
|
1375
|
+
end
|
1376
|
+
end
|
1377
|
+
end
|