google-apis-genomics_v2alpha1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d05677013c11c3c7044df9d19d862ee4143bbc20dc7b5315eb97310e41c3e681
4
+ data.tar.gz: 2318b90e8e7dd9ccad9ea6e85d4e52d8c7f66ff7e0e7f2dea7f584fe4dbce1bd
5
+ SHA512:
6
+ metadata.gz: b8c4c17b247d67e369fbd420106def4065a44a1386f2cdea112e21f9147555780abd753f2710d3bc15d442946d46145b8eb541ad15eff0e6f11174999446c766
7
+ data.tar.gz: ac810e217a1b37a3e308db8c53cd5dafdbf33e453545d23e1bd9fcb7271d8d04d8a18cd5685189b9d4ce17acbe95692c140063b937e92bac93aa6a575b69da49
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-genomics_v2alpha1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/genomics_v2alpha1/*.rb
9
+ lib/google/apis/genomics_v2alpha1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-genomics_v2alpha1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated from discovery document revision 20201231
6
+ * Regenerated using generator version 0.1.1
7
+
@@ -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.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V2alpha1 of the Genomics API
2
+
3
+ This is a simple client library for version V2alpha1 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_v2alpha1', '~> 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_v2alpha1
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_v2alpha1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::GenomicsV2alpha1::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::GenomicsV2alpha1::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_v2alpha1`, 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_v2alpha1"
@@ -0,0 +1,39 @@
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_v2alpha1/service.rb'
16
+ require 'google/apis/genomics_v2alpha1/classes.rb'
17
+ require 'google/apis/genomics_v2alpha1/representations.rb'
18
+ require 'google/apis/genomics_v2alpha1/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 GenomicsV2alpha1
28
+ # Version of the Genomics API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V2alpha1'
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 Genomics data
36
+ AUTH_GENOMICS = 'https://www.googleapis.com/auth/genomics'
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,1601 @@
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 GenomicsV2alpha1
24
+
25
+ # Carries information about an accelerator that can be attached to a VM.
26
+ class Accelerator
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # How many accelerators of this type to attach.
30
+ # Corresponds to the JSON property `count`
31
+ # @return [Fixnum]
32
+ attr_accessor :count
33
+
34
+ # The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU
35
+ # accelerators are currently supported. If an NVIDIA GPU is attached, the
36
+ # required runtime libraries will be made available to all containers under `/
37
+ # usr/local/nvidia`. The driver version to install must be specified using the
38
+ # NVIDIA driver version parameter on the virtual machine specification. Note
39
+ # that attaching a GPU increases the worker VM startup time by a few minutes.
40
+ # Corresponds to the JSON property `type`
41
+ # @return [String]
42
+ attr_accessor :type
43
+
44
+ def initialize(**args)
45
+ update!(**args)
46
+ end
47
+
48
+ # Update properties of this object
49
+ def update!(**args)
50
+ @count = args[:count] if args.key?(:count)
51
+ @type = args[:type] if args.key?(:type)
52
+ end
53
+ end
54
+
55
+ # Specifies a single action that runs a Docker container.
56
+ class Action
57
+ include Google::Apis::Core::Hashable
58
+
59
+ # If specified, overrides the `CMD` specified in the container. If the container
60
+ # also has an `ENTRYPOINT` the values are used as entrypoint arguments.
61
+ # Otherwise, they are used as a command and arguments to run inside the
62
+ # container.
63
+ # Corresponds to the JSON property `commands`
64
+ # @return [Array<String>]
65
+ attr_accessor :commands
66
+
67
+ # Holds encrypted information that is only decrypted and stored in RAM by the
68
+ # worker VM when running the pipeline.
69
+ # Corresponds to the JSON property `credentials`
70
+ # @return [Google::Apis::GenomicsV2alpha1::Secret]
71
+ attr_accessor :credentials
72
+
73
+ # If specified, overrides the `ENTRYPOINT` specified in the container.
74
+ # Corresponds to the JSON property `entrypoint`
75
+ # @return [String]
76
+ attr_accessor :entrypoint
77
+
78
+ # The environment to pass into the container. This environment is merged with
79
+ # values specified in the google.genomics.v2alpha1.Pipeline message, overwriting
80
+ # any duplicate values. In addition to the values passed here, a few other
81
+ # values are automatically injected into the environment. These cannot be hidden
82
+ # or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline
83
+ # failed because an action has exited with a non-zero status (and did not have
84
+ # the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if
85
+ # additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS`
86
+ # will be set to the exit status of the last non-background action that executed.
87
+ # This can be used by workflow engine authors to determine whether an
88
+ # individual action has succeeded or failed.
89
+ # Corresponds to the JSON property `environment`
90
+ # @return [Hash<String,String>]
91
+ attr_accessor :environment
92
+
93
+ # The set of flags to apply to this action.
94
+ # Corresponds to the JSON property `flags`
95
+ # @return [Array<String>]
96
+ attr_accessor :flags
97
+
98
+ # Required. The URI to pull the container image from. Note that all images
99
+ # referenced by actions in the pipeline are pulled before the first action runs.
100
+ # If multiple actions reference the same image, it is only pulled once, ensuring
101
+ # that the same image is used for all actions in a single pipeline. The image
102
+ # URI can be either a complete host and image specification (e.g., quay.io/
103
+ # biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or
104
+ # a bare image name ('bash') to pull from the default library. No schema is
105
+ # required in any of these cases. If the specified image is not public, the
106
+ # service account specified for the Virtual Machine must have access to pull the
107
+ # images from GCR, or appropriate credentials must be specified in the google.
108
+ # genomics.v2alpha1.Action.credentials field.
109
+ # Corresponds to the JSON property `imageUri`
110
+ # @return [String]
111
+ attr_accessor :image_uri
112
+
113
+ # Labels to associate with the action. This field is provided to assist workflow
114
+ # engine authors in identifying actions (for example, to indicate what sort of
115
+ # action they perform, such as localization or debugging). They are returned in
116
+ # the operation metadata, but are otherwise ignored.
117
+ # Corresponds to the JSON property `labels`
118
+ # @return [Hash<String,String>]
119
+ attr_accessor :labels
120
+
121
+ # A list of mounts to make available to the action. In addition to the values
122
+ # specified here, every action has a special virtual disk mounted under `/google`
123
+ # that contains log files and other operational components. - /google/logs All
124
+ # logs written during the pipeline execution. - /google/logs/output The combined
125
+ # standard output and standard error of all actions run as part of the pipeline
126
+ # execution. - /google/logs/action/*/stdout The complete contents of each
127
+ # individual action's standard output. - /google/logs/action/*/stderr The
128
+ # complete contents of each individual action's standard error output.
129
+ # Corresponds to the JSON property `mounts`
130
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Mount>]
131
+ attr_accessor :mounts
132
+
133
+ # An optional name for the container. The container hostname will be set to this
134
+ # name, making it useful for inter-container communication. The name must
135
+ # contain only upper and lowercase alphanumeric characters and hyphens and
136
+ # cannot start with a hyphen.
137
+ # Corresponds to the JSON property `name`
138
+ # @return [String]
139
+ attr_accessor :name
140
+
141
+ # An optional identifier for a PID namespace to run the action inside. Multiple
142
+ # actions should use the same string to share a namespace. If unspecified, a
143
+ # separate isolated namespace is used.
144
+ # Corresponds to the JSON property `pidNamespace`
145
+ # @return [String]
146
+ attr_accessor :pid_namespace
147
+
148
+ # A map of containers to host port mappings for this container. If the container
149
+ # already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead.
150
+ # The host port number must be less than 65536. If it is zero, an unused random
151
+ # port is assigned. To determine the resulting port number, consult the `
152
+ # ContainerStartedEvent` in the operation metadata.
153
+ # Corresponds to the JSON property `portMappings`
154
+ # @return [Hash<String,Fixnum>]
155
+ attr_accessor :port_mappings
156
+
157
+ # The maximum amount of time to give the action to complete. If the action fails
158
+ # to complete before the timeout, it will be terminated and the exit status will
159
+ # be non-zero. The pipeline will continue or terminate based on the rules
160
+ # defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
161
+ # Corresponds to the JSON property `timeout`
162
+ # @return [String]
163
+ attr_accessor :timeout
164
+
165
+ def initialize(**args)
166
+ update!(**args)
167
+ end
168
+
169
+ # Update properties of this object
170
+ def update!(**args)
171
+ @commands = args[:commands] if args.key?(:commands)
172
+ @credentials = args[:credentials] if args.key?(:credentials)
173
+ @entrypoint = args[:entrypoint] if args.key?(:entrypoint)
174
+ @environment = args[:environment] if args.key?(:environment)
175
+ @flags = args[:flags] if args.key?(:flags)
176
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
177
+ @labels = args[:labels] if args.key?(:labels)
178
+ @mounts = args[:mounts] if args.key?(:mounts)
179
+ @name = args[:name] if args.key?(:name)
180
+ @pid_namespace = args[:pid_namespace] if args.key?(:pid_namespace)
181
+ @port_mappings = args[:port_mappings] if args.key?(:port_mappings)
182
+ @timeout = args[:timeout] if args.key?(:timeout)
183
+ end
184
+ end
185
+
186
+ # The request message for Operations.CancelOperation.
187
+ class CancelOperationRequest
188
+ include Google::Apis::Core::Hashable
189
+
190
+ def initialize(**args)
191
+ update!(**args)
192
+ end
193
+
194
+ # Update properties of this object
195
+ def update!(**args)
196
+ end
197
+ end
198
+
199
+ # The parameters to the CheckIn method.
200
+ class CheckInRequest
201
+ include Google::Apis::Core::Hashable
202
+
203
+ # A generic empty message that you can re-use to avoid defining duplicated empty
204
+ # messages in your APIs. A typical example is to use it as the request or the
205
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
206
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
207
+ # `Empty` is empty JSON object ````.
208
+ # Corresponds to the JSON property `deadlineExpired`
209
+ # @return [Google::Apis::GenomicsV2alpha1::Empty]
210
+ attr_accessor :deadline_expired
211
+
212
+ # A workflow specific event occurred.
213
+ # Corresponds to the JSON property `event`
214
+ # @return [Hash<String,Object>]
215
+ attr_accessor :event
216
+
217
+ # A list of timestamped events.
218
+ # Corresponds to the JSON property `events`
219
+ # @return [Array<Google::Apis::GenomicsV2alpha1::TimestampedEvent>]
220
+ attr_accessor :events
221
+
222
+ # The `Status` type defines a logical error model that is suitable for different
223
+ # programming environments, including REST APIs and RPC APIs. It is used by [
224
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
225
+ # data: error code, error message, and error details. You can find out more
226
+ # about this error model and how to work with it in the [API Design Guide](https:
227
+ # //cloud.google.com/apis/design/errors).
228
+ # Corresponds to the JSON property `result`
229
+ # @return [Google::Apis::GenomicsV2alpha1::Status]
230
+ attr_accessor :result
231
+
232
+ # An SOS report for an unexpected VM failure.
233
+ # Corresponds to the JSON property `sosReport`
234
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
235
+ # @return [String]
236
+ attr_accessor :sos_report
237
+
238
+ # The status of the worker VM.
239
+ # Corresponds to the JSON property `workerStatus`
240
+ # @return [Google::Apis::GenomicsV2alpha1::WorkerStatus]
241
+ attr_accessor :worker_status
242
+
243
+ def initialize(**args)
244
+ update!(**args)
245
+ end
246
+
247
+ # Update properties of this object
248
+ def update!(**args)
249
+ @deadline_expired = args[:deadline_expired] if args.key?(:deadline_expired)
250
+ @event = args[:event] if args.key?(:event)
251
+ @events = args[:events] if args.key?(:events)
252
+ @result = args[:result] if args.key?(:result)
253
+ @sos_report = args[:sos_report] if args.key?(:sos_report)
254
+ @worker_status = args[:worker_status] if args.key?(:worker_status)
255
+ end
256
+ end
257
+
258
+ # The response to the CheckIn method.
259
+ class CheckInResponse
260
+ include Google::Apis::Core::Hashable
261
+
262
+ # The deadline by which the worker must request an extension. The backend will
263
+ # allow for network transmission time and other delays, but the worker must
264
+ # attempt to transmit the extension request no later than the deadline.
265
+ # Corresponds to the JSON property `deadline`
266
+ # @return [String]
267
+ attr_accessor :deadline
268
+
269
+ # The metadata that describes the operation assigned to the worker.
270
+ # Corresponds to the JSON property `metadata`
271
+ # @return [Hash<String,Object>]
272
+ attr_accessor :metadata
273
+
274
+ def initialize(**args)
275
+ update!(**args)
276
+ end
277
+
278
+ # Update properties of this object
279
+ def update!(**args)
280
+ @deadline = args[:deadline] if args.key?(:deadline)
281
+ @metadata = args[:metadata] if args.key?(:metadata)
282
+ end
283
+ end
284
+
285
+ # Describes a Compute Engine resource that is being managed by a running
286
+ # pipeline.
287
+ class ComputeEngine
288
+ include Google::Apis::Core::Hashable
289
+
290
+ # The names of the disks that were created for this pipeline.
291
+ # Corresponds to the JSON property `diskNames`
292
+ # @return [Array<String>]
293
+ attr_accessor :disk_names
294
+
295
+ # The instance on which the operation is running.
296
+ # Corresponds to the JSON property `instanceName`
297
+ # @return [String]
298
+ attr_accessor :instance_name
299
+
300
+ # The machine type of the instance.
301
+ # Corresponds to the JSON property `machineType`
302
+ # @return [String]
303
+ attr_accessor :machine_type
304
+
305
+ # The availability zone in which the instance resides.
306
+ # Corresponds to the JSON property `zone`
307
+ # @return [String]
308
+ attr_accessor :zone
309
+
310
+ def initialize(**args)
311
+ update!(**args)
312
+ end
313
+
314
+ # Update properties of this object
315
+ def update!(**args)
316
+ @disk_names = args[:disk_names] if args.key?(:disk_names)
317
+ @instance_name = args[:instance_name] if args.key?(:instance_name)
318
+ @machine_type = args[:machine_type] if args.key?(:machine_type)
319
+ @zone = args[:zone] if args.key?(:zone)
320
+ end
321
+ end
322
+
323
+ # An event generated when a container is forcibly terminated by the worker.
324
+ # Currently, this only occurs when the container outlives the timeout specified
325
+ # by the user.
326
+ class ContainerKilledEvent
327
+ include Google::Apis::Core::Hashable
328
+
329
+ # The numeric ID of the action that started the container.
330
+ # Corresponds to the JSON property `actionId`
331
+ # @return [Fixnum]
332
+ attr_accessor :action_id
333
+
334
+ def initialize(**args)
335
+ update!(**args)
336
+ end
337
+
338
+ # Update properties of this object
339
+ def update!(**args)
340
+ @action_id = args[:action_id] if args.key?(:action_id)
341
+ end
342
+ end
343
+
344
+ # An event generated when a container starts.
345
+ class ContainerStartedEvent
346
+ include Google::Apis::Core::Hashable
347
+
348
+ # The numeric ID of the action that started this container.
349
+ # Corresponds to the JSON property `actionId`
350
+ # @return [Fixnum]
351
+ attr_accessor :action_id
352
+
353
+ # The public IP address that can be used to connect to the container. This field
354
+ # is only populated when at least one port mapping is present. If the instance
355
+ # was created with a private address, this field will be empty even if port
356
+ # mappings exist.
357
+ # Corresponds to the JSON property `ipAddress`
358
+ # @return [String]
359
+ attr_accessor :ip_address
360
+
361
+ # The container-to-host port mappings installed for this container. This set
362
+ # will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well
363
+ # as any specified in the `Action` definition.
364
+ # Corresponds to the JSON property `portMappings`
365
+ # @return [Hash<String,Fixnum>]
366
+ attr_accessor :port_mappings
367
+
368
+ def initialize(**args)
369
+ update!(**args)
370
+ end
371
+
372
+ # Update properties of this object
373
+ def update!(**args)
374
+ @action_id = args[:action_id] if args.key?(:action_id)
375
+ @ip_address = args[:ip_address] if args.key?(:ip_address)
376
+ @port_mappings = args[:port_mappings] if args.key?(:port_mappings)
377
+ end
378
+ end
379
+
380
+ # An event generated when a container exits.
381
+ class ContainerStoppedEvent
382
+ include Google::Apis::Core::Hashable
383
+
384
+ # The numeric ID of the action that started this container.
385
+ # Corresponds to the JSON property `actionId`
386
+ # @return [Fixnum]
387
+ attr_accessor :action_id
388
+
389
+ # The exit status of the container.
390
+ # Corresponds to the JSON property `exitStatus`
391
+ # @return [Fixnum]
392
+ attr_accessor :exit_status
393
+
394
+ # The tail end of any content written to standard error by the container. If the
395
+ # content emits large amounts of debugging noise or contains sensitive
396
+ # information, you can prevent the content from being printed by setting the `
397
+ # DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end
398
+ # of the stream is captured here. The entire stream is stored in the `/google/
399
+ # logs` directory mounted into each action, and can be copied off the machine as
400
+ # described elsewhere.
401
+ # Corresponds to the JSON property `stderr`
402
+ # @return [String]
403
+ attr_accessor :stderr
404
+
405
+ def initialize(**args)
406
+ update!(**args)
407
+ end
408
+
409
+ # Update properties of this object
410
+ def update!(**args)
411
+ @action_id = args[:action_id] if args.key?(:action_id)
412
+ @exit_status = args[:exit_status] if args.key?(:exit_status)
413
+ @stderr = args[:stderr] if args.key?(:stderr)
414
+ end
415
+ end
416
+
417
+ # An event generated whenever a resource limitation or transient error delays
418
+ # execution of a pipeline that was otherwise ready to run.
419
+ class DelayedEvent
420
+ include Google::Apis::Core::Hashable
421
+
422
+ # A textual description of the cause of the delay. The string can change without
423
+ # notice because it is often generated by another service (such as Compute
424
+ # Engine).
425
+ # Corresponds to the JSON property `cause`
426
+ # @return [String]
427
+ attr_accessor :cause
428
+
429
+ # If the delay was caused by a resource shortage, this field lists the Compute
430
+ # Engine metrics that are preventing this operation from running (for example, `
431
+ # CPUS` or `INSTANCES`). If the particular metric is not known, a single `
432
+ # UNKNOWN` metric will be present.
433
+ # Corresponds to the JSON property `metrics`
434
+ # @return [Array<String>]
435
+ attr_accessor :metrics
436
+
437
+ def initialize(**args)
438
+ update!(**args)
439
+ end
440
+
441
+ # Update properties of this object
442
+ def update!(**args)
443
+ @cause = args[:cause] if args.key?(:cause)
444
+ @metrics = args[:metrics] if args.key?(:metrics)
445
+ end
446
+ end
447
+
448
+ # Carries information about a disk that can be attached to a VM. See https://
449
+ # cloud.google.com/compute/docs/disks/performance for more information about
450
+ # disk type, size, and performance considerations. Specify either `Volume` or `
451
+ # Disk`, but not both.
452
+ class Disk
453
+ include Google::Apis::Core::Hashable
454
+
455
+ # A user-supplied name for the disk. Used when mounting the disk into actions.
456
+ # The name must contain only upper and lowercase alphanumeric characters and
457
+ # hyphens and cannot start with a hyphen.
458
+ # Corresponds to the JSON property `name`
459
+ # @return [String]
460
+ attr_accessor :name
461
+
462
+ # The size, in GB, of the disk to attach. If the size is not specified, a
463
+ # default is chosen to ensure reasonable I/O performance. If the disk type is
464
+ # specified as `local-ssd`, multiple local drives are automatically combined to
465
+ # provide the requested size. Note, however, that each physical SSD is 375GB in
466
+ # size, and no more than 8 drives can be attached to a single instance.
467
+ # Corresponds to the JSON property `sizeGb`
468
+ # @return [Fixnum]
469
+ attr_accessor :size_gb
470
+
471
+ # An optional image to put on the disk before attaching it to the VM.
472
+ # Corresponds to the JSON property `sourceImage`
473
+ # @return [String]
474
+ attr_accessor :source_image
475
+
476
+ # The Compute Engine disk type. If unspecified, `pd-standard` is used.
477
+ # Corresponds to the JSON property `type`
478
+ # @return [String]
479
+ attr_accessor :type
480
+
481
+ def initialize(**args)
482
+ update!(**args)
483
+ end
484
+
485
+ # Update properties of this object
486
+ def update!(**args)
487
+ @name = args[:name] if args.key?(:name)
488
+ @size_gb = args[:size_gb] if args.key?(:size_gb)
489
+ @source_image = args[:source_image] if args.key?(:source_image)
490
+ @type = args[:type] if args.key?(:type)
491
+ end
492
+ end
493
+
494
+ # The status of a disk on a VM.
495
+ class DiskStatus
496
+ include Google::Apis::Core::Hashable
497
+
498
+ # Free disk space.
499
+ # Corresponds to the JSON property `freeSpaceBytes`
500
+ # @return [Fixnum]
501
+ attr_accessor :free_space_bytes
502
+
503
+ # Total disk space.
504
+ # Corresponds to the JSON property `totalSpaceBytes`
505
+ # @return [Fixnum]
506
+ attr_accessor :total_space_bytes
507
+
508
+ def initialize(**args)
509
+ update!(**args)
510
+ end
511
+
512
+ # Update properties of this object
513
+ def update!(**args)
514
+ @free_space_bytes = args[:free_space_bytes] if args.key?(:free_space_bytes)
515
+ @total_space_bytes = args[:total_space_bytes] if args.key?(:total_space_bytes)
516
+ end
517
+ end
518
+
519
+ # A generic empty message that you can re-use to avoid defining duplicated empty
520
+ # messages in your APIs. A typical example is to use it as the request or the
521
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
522
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
523
+ # `Empty` is empty JSON object ````.
524
+ class Empty
525
+ include Google::Apis::Core::Hashable
526
+
527
+ def initialize(**args)
528
+ update!(**args)
529
+ end
530
+
531
+ # Update properties of this object
532
+ def update!(**args)
533
+ end
534
+ end
535
+
536
+ # Carries information about events that occur during pipeline execution.
537
+ class Event
538
+ include Google::Apis::Core::Hashable
539
+
540
+ # A human-readable description of the event. Note that these strings can change
541
+ # at any time without notice. Any application logic must use the information in
542
+ # the `details` field.
543
+ # Corresponds to the JSON property `description`
544
+ # @return [String]
545
+ attr_accessor :description
546
+
547
+ # Machine-readable details about the event.
548
+ # Corresponds to the JSON property `details`
549
+ # @return [Hash<String,Object>]
550
+ attr_accessor :details
551
+
552
+ # The time at which the event occurred.
553
+ # Corresponds to the JSON property `timestamp`
554
+ # @return [String]
555
+ attr_accessor :timestamp
556
+
557
+ def initialize(**args)
558
+ update!(**args)
559
+ end
560
+
561
+ # Update properties of this object
562
+ def update!(**args)
563
+ @description = args[:description] if args.key?(:description)
564
+ @details = args[:details] if args.key?(:details)
565
+ @timestamp = args[:timestamp] if args.key?(:timestamp)
566
+ end
567
+ end
568
+
569
+ # Configuration for an existing disk to be attached to the VM.
570
+ class ExistingDisk
571
+ include Google::Apis::Core::Hashable
572
+
573
+ # If `disk` contains slashes, the Cloud Life Sciences API assumes that it is a
574
+ # complete URL for the disk. If `disk` does not contain slashes, the Cloud Life
575
+ # Sciences API assumes that the disk is a zonal disk and a URL will be generated
576
+ # of the form `zones//disks/`, where `` is the zone in which the instance is
577
+ # allocated. The disk must be ext4 formatted. If all `Mount` references to this
578
+ # disk have the `read_only` flag set to true, the disk will be attached in `read-
579
+ # only` mode and can be shared with other instances. Otherwise, the disk will be
580
+ # available for writing but cannot be shared.
581
+ # Corresponds to the JSON property `disk`
582
+ # @return [String]
583
+ attr_accessor :disk
584
+
585
+ def initialize(**args)
586
+ update!(**args)
587
+ end
588
+
589
+ # Update properties of this object
590
+ def update!(**args)
591
+ @disk = args[:disk] if args.key?(:disk)
592
+ end
593
+ end
594
+
595
+ # An event generated when the execution of a pipeline has failed. Note that
596
+ # other events can continue to occur after this event.
597
+ class FailedEvent
598
+ include Google::Apis::Core::Hashable
599
+
600
+ # The human-readable description of the cause of the failure.
601
+ # Corresponds to the JSON property `cause`
602
+ # @return [String]
603
+ attr_accessor :cause
604
+
605
+ # The Google standard error code that best describes this failure.
606
+ # Corresponds to the JSON property `code`
607
+ # @return [String]
608
+ attr_accessor :code
609
+
610
+ def initialize(**args)
611
+ update!(**args)
612
+ end
613
+
614
+ # Update properties of this object
615
+ def update!(**args)
616
+ @cause = args[:cause] if args.key?(:cause)
617
+ @code = args[:code] if args.key?(:code)
618
+ end
619
+ end
620
+
621
+ # The response message for Operations.ListOperations.
622
+ class ListOperationsResponse
623
+ include Google::Apis::Core::Hashable
624
+
625
+ # The standard List next-page token.
626
+ # Corresponds to the JSON property `nextPageToken`
627
+ # @return [String]
628
+ attr_accessor :next_page_token
629
+
630
+ # A list of operations that matches the specified filter in the request.
631
+ # Corresponds to the JSON property `operations`
632
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Operation>]
633
+ attr_accessor :operations
634
+
635
+ def initialize(**args)
636
+ update!(**args)
637
+ end
638
+
639
+ # Update properties of this object
640
+ def update!(**args)
641
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
642
+ @operations = args[:operations] if args.key?(:operations)
643
+ end
644
+ end
645
+
646
+ # Carries information about the pipeline execution that is returned in the long
647
+ # running operation's metadata field.
648
+ class Metadata
649
+ include Google::Apis::Core::Hashable
650
+
651
+ # The time at which the operation was created by the API.
652
+ # Corresponds to the JSON property `createTime`
653
+ # @return [String]
654
+ attr_accessor :create_time
655
+
656
+ # The time at which execution was completed and resources were cleaned up.
657
+ # Corresponds to the JSON property `endTime`
658
+ # @return [String]
659
+ attr_accessor :end_time
660
+
661
+ # The list of events that have happened so far during the execution of this
662
+ # operation.
663
+ # Corresponds to the JSON property `events`
664
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Event>]
665
+ attr_accessor :events
666
+
667
+ # The user-defined labels associated with this operation.
668
+ # Corresponds to the JSON property `labels`
669
+ # @return [Hash<String,String>]
670
+ attr_accessor :labels
671
+
672
+ # Specifies a series of actions to execute, expressed as Docker containers.
673
+ # Corresponds to the JSON property `pipeline`
674
+ # @return [Google::Apis::GenomicsV2alpha1::Pipeline]
675
+ attr_accessor :pipeline
676
+
677
+ # The first time at which resources were allocated to execute the pipeline.
678
+ # Corresponds to the JSON property `startTime`
679
+ # @return [String]
680
+ attr_accessor :start_time
681
+
682
+ def initialize(**args)
683
+ update!(**args)
684
+ end
685
+
686
+ # Update properties of this object
687
+ def update!(**args)
688
+ @create_time = args[:create_time] if args.key?(:create_time)
689
+ @end_time = args[:end_time] if args.key?(:end_time)
690
+ @events = args[:events] if args.key?(:events)
691
+ @labels = args[:labels] if args.key?(:labels)
692
+ @pipeline = args[:pipeline] if args.key?(:pipeline)
693
+ @start_time = args[:start_time] if args.key?(:start_time)
694
+ end
695
+ end
696
+
697
+ # Carries information about a particular disk mount inside a container.
698
+ class Mount
699
+ include Google::Apis::Core::Hashable
700
+
701
+ # The name of the disk to mount, as specified in the resources section.
702
+ # Corresponds to the JSON property `disk`
703
+ # @return [String]
704
+ attr_accessor :disk
705
+
706
+ # The path to mount the disk inside the container.
707
+ # Corresponds to the JSON property `path`
708
+ # @return [String]
709
+ attr_accessor :path
710
+
711
+ # If true, the disk is mounted read-only inside the container.
712
+ # Corresponds to the JSON property `readOnly`
713
+ # @return [Boolean]
714
+ attr_accessor :read_only
715
+ alias_method :read_only?, :read_only
716
+
717
+ def initialize(**args)
718
+ update!(**args)
719
+ end
720
+
721
+ # Update properties of this object
722
+ def update!(**args)
723
+ @disk = args[:disk] if args.key?(:disk)
724
+ @path = args[:path] if args.key?(:path)
725
+ @read_only = args[:read_only] if args.key?(:read_only)
726
+ end
727
+ end
728
+
729
+ # Configuration for an `NFSMount` to be attached to the VM.
730
+ class NfsMount
731
+ include Google::Apis::Core::Hashable
732
+
733
+ # A target NFS mount. The target must be specified as `address:/mount".
734
+ # Corresponds to the JSON property `target`
735
+ # @return [String]
736
+ attr_accessor :target
737
+
738
+ def initialize(**args)
739
+ update!(**args)
740
+ end
741
+
742
+ # Update properties of this object
743
+ def update!(**args)
744
+ @target = args[:target] if args.key?(:target)
745
+ end
746
+ end
747
+
748
+ # VM networking options.
749
+ class Network
750
+ include Google::Apis::Core::Hashable
751
+
752
+ # The network name to attach the VM's network interface to. The value will be
753
+ # prefixed with `global/networks/` unless it contains a `/`, in which case it is
754
+ # assumed to be a fully specified network resource URL. If unspecified, the
755
+ # global default network is used.
756
+ # Corresponds to the JSON property `name`
757
+ # @return [String]
758
+ attr_accessor :name
759
+
760
+ # If the specified network is configured for custom subnet creation, the name of
761
+ # the subnetwork to attach the instance to must be specified here. The value is
762
+ # prefixed with `regions/*/subnetworks/` unless it contains a `/`, in which case
763
+ # it is assumed to be a fully specified subnetwork resource URL. If the `*`
764
+ # character appears in the value, it is replaced with the region that the
765
+ # virtual machine has been allocated in.
766
+ # Corresponds to the JSON property `subnetwork`
767
+ # @return [String]
768
+ attr_accessor :subnetwork
769
+
770
+ # If set to true, do not attach a public IP address to the VM. Note that without
771
+ # a public IP address, additional configuration is required to allow the VM to
772
+ # access Google services. See https://cloud.google.com/vpc/docs/configure-
773
+ # private-google-access for more information.
774
+ # Corresponds to the JSON property `usePrivateAddress`
775
+ # @return [Boolean]
776
+ attr_accessor :use_private_address
777
+ alias_method :use_private_address?, :use_private_address
778
+
779
+ def initialize(**args)
780
+ update!(**args)
781
+ end
782
+
783
+ # Update properties of this object
784
+ def update!(**args)
785
+ @name = args[:name] if args.key?(:name)
786
+ @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
787
+ @use_private_address = args[:use_private_address] if args.key?(:use_private_address)
788
+ end
789
+ end
790
+
791
+ # This resource represents a long-running operation that is the result of a
792
+ # network API call.
793
+ class Operation
794
+ include Google::Apis::Core::Hashable
795
+
796
+ # If the value is `false`, it means the operation is still in progress. If `true`
797
+ # , the operation is completed, and either `error` or `response` is available.
798
+ # Corresponds to the JSON property `done`
799
+ # @return [Boolean]
800
+ attr_accessor :done
801
+ alias_method :done?, :done
802
+
803
+ # The `Status` type defines a logical error model that is suitable for different
804
+ # programming environments, including REST APIs and RPC APIs. It is used by [
805
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
806
+ # data: error code, error message, and error details. You can find out more
807
+ # about this error model and how to work with it in the [API Design Guide](https:
808
+ # //cloud.google.com/apis/design/errors).
809
+ # Corresponds to the JSON property `error`
810
+ # @return [Google::Apis::GenomicsV2alpha1::Status]
811
+ attr_accessor :error
812
+
813
+ # An OperationMetadata or Metadata object. This will always be returned with the
814
+ # Operation.
815
+ # Corresponds to the JSON property `metadata`
816
+ # @return [Hash<String,Object>]
817
+ attr_accessor :metadata
818
+
819
+ # The server-assigned name, which is only unique within the same service that
820
+ # originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-
821
+ # qzoWAgEw`
822
+ # Corresponds to the JSON property `name`
823
+ # @return [String]
824
+ attr_accessor :name
825
+
826
+ # An Empty object.
827
+ # Corresponds to the JSON property `response`
828
+ # @return [Hash<String,Object>]
829
+ attr_accessor :response
830
+
831
+ def initialize(**args)
832
+ update!(**args)
833
+ end
834
+
835
+ # Update properties of this object
836
+ def update!(**args)
837
+ @done = args[:done] if args.key?(:done)
838
+ @error = args[:error] if args.key?(:error)
839
+ @metadata = args[:metadata] if args.key?(:metadata)
840
+ @name = args[:name] if args.key?(:name)
841
+ @response = args[:response] if args.key?(:response)
842
+ end
843
+ end
844
+
845
+ # An event that occurred during an Operation.
846
+ class OperationEvent
847
+ include Google::Apis::Core::Hashable
848
+
849
+ # Required description of event.
850
+ # Corresponds to the JSON property `description`
851
+ # @return [String]
852
+ attr_accessor :description
853
+
854
+ # Optional time of when event finished. An event can have a start time and no
855
+ # finish time. If an event has a finish time, there must be a start time.
856
+ # Corresponds to the JSON property `endTime`
857
+ # @return [String]
858
+ attr_accessor :end_time
859
+
860
+ # Optional time of when event started.
861
+ # Corresponds to the JSON property `startTime`
862
+ # @return [String]
863
+ attr_accessor :start_time
864
+
865
+ def initialize(**args)
866
+ update!(**args)
867
+ end
868
+
869
+ # Update properties of this object
870
+ def update!(**args)
871
+ @description = args[:description] if args.key?(:description)
872
+ @end_time = args[:end_time] if args.key?(:end_time)
873
+ @start_time = args[:start_time] if args.key?(:start_time)
874
+ end
875
+ end
876
+
877
+ # Metadata describing an Operation.
878
+ class OperationMetadata
879
+ include Google::Apis::Core::Hashable
880
+
881
+ # This field is deprecated. Use `labels` instead. Optionally provided by the
882
+ # caller when submitting the request that creates the operation.
883
+ # Corresponds to the JSON property `clientId`
884
+ # @return [String]
885
+ attr_accessor :client_id
886
+
887
+ # The time at which the job was submitted to the Genomics service.
888
+ # Corresponds to the JSON property `createTime`
889
+ # @return [String]
890
+ attr_accessor :create_time
891
+
892
+ # The time at which the job stopped running.
893
+ # Corresponds to the JSON property `endTime`
894
+ # @return [String]
895
+ attr_accessor :end_time
896
+
897
+ # Optional event messages that were generated during the job's execution. This
898
+ # also contains any warnings that were generated during import or export.
899
+ # Corresponds to the JSON property `events`
900
+ # @return [Array<Google::Apis::GenomicsV2alpha1::OperationEvent>]
901
+ attr_accessor :events
902
+
903
+ # Optionally provided by the caller when submitting the request that creates the
904
+ # operation.
905
+ # Corresponds to the JSON property `labels`
906
+ # @return [Hash<String,String>]
907
+ attr_accessor :labels
908
+
909
+ # The Google Cloud Project in which the job is scoped.
910
+ # Corresponds to the JSON property `projectId`
911
+ # @return [String]
912
+ attr_accessor :project_id
913
+
914
+ # The original request that started the operation. Note that this will be in
915
+ # current version of the API. If the operation was started with v1beta2 API and
916
+ # a GetOperation is performed on v1 API, a v1 request will be returned.
917
+ # Corresponds to the JSON property `request`
918
+ # @return [Hash<String,Object>]
919
+ attr_accessor :request
920
+
921
+ # Runtime metadata on this Operation.
922
+ # Corresponds to the JSON property `runtimeMetadata`
923
+ # @return [Hash<String,Object>]
924
+ attr_accessor :runtime_metadata
925
+
926
+ # The time at which the job began to run.
927
+ # Corresponds to the JSON property `startTime`
928
+ # @return [String]
929
+ attr_accessor :start_time
930
+
931
+ def initialize(**args)
932
+ update!(**args)
933
+ end
934
+
935
+ # Update properties of this object
936
+ def update!(**args)
937
+ @client_id = args[:client_id] if args.key?(:client_id)
938
+ @create_time = args[:create_time] if args.key?(:create_time)
939
+ @end_time = args[:end_time] if args.key?(:end_time)
940
+ @events = args[:events] if args.key?(:events)
941
+ @labels = args[:labels] if args.key?(:labels)
942
+ @project_id = args[:project_id] if args.key?(:project_id)
943
+ @request = args[:request] if args.key?(:request)
944
+ @runtime_metadata = args[:runtime_metadata] if args.key?(:runtime_metadata)
945
+ @start_time = args[:start_time] if args.key?(:start_time)
946
+ end
947
+ end
948
+
949
+ # Configuration for a persistent disk to be attached to the VM. See https://
950
+ # cloud.google.com/compute/docs/disks/performance for more information about
951
+ # disk type, size, and performance considerations.
952
+ class PersistentDisk
953
+ include Google::Apis::Core::Hashable
954
+
955
+ # The size, in GB, of the disk to attach. If the size is not specified, a
956
+ # default is chosen to ensure reasonable I/O performance. If the disk type is
957
+ # specified as `local-ssd`, multiple local drives are automatically combined to
958
+ # provide the requested size. Note, however, that each physical SSD is 375GB in
959
+ # size, and no more than 8 drives can be attached to a single instance.
960
+ # Corresponds to the JSON property `sizeGb`
961
+ # @return [Fixnum]
962
+ attr_accessor :size_gb
963
+
964
+ # An image to put on the disk before attaching it to the VM.
965
+ # Corresponds to the JSON property `sourceImage`
966
+ # @return [String]
967
+ attr_accessor :source_image
968
+
969
+ # The Compute Engine disk type. If unspecified, `pd-standard` is used.
970
+ # Corresponds to the JSON property `type`
971
+ # @return [String]
972
+ attr_accessor :type
973
+
974
+ def initialize(**args)
975
+ update!(**args)
976
+ end
977
+
978
+ # Update properties of this object
979
+ def update!(**args)
980
+ @size_gb = args[:size_gb] if args.key?(:size_gb)
981
+ @source_image = args[:source_image] if args.key?(:source_image)
982
+ @type = args[:type] if args.key?(:type)
983
+ end
984
+ end
985
+
986
+ # Specifies a series of actions to execute, expressed as Docker containers.
987
+ class Pipeline
988
+ include Google::Apis::Core::Hashable
989
+
990
+ # The list of actions to execute, in the order they are specified.
991
+ # Corresponds to the JSON property `actions`
992
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Action>]
993
+ attr_accessor :actions
994
+
995
+ # The environment to pass into every action. Each action can also specify
996
+ # additional environment variables but cannot delete an entry from this map (
997
+ # though they can overwrite it with a different value).
998
+ # Corresponds to the JSON property `environment`
999
+ # @return [Hash<String,String>]
1000
+ attr_accessor :environment
1001
+
1002
+ # The system resources for the pipeline run. At least one zone or region must be
1003
+ # specified or the pipeline run will fail.
1004
+ # Corresponds to the JSON property `resources`
1005
+ # @return [Google::Apis::GenomicsV2alpha1::Resources]
1006
+ attr_accessor :resources
1007
+
1008
+ # The maximum amount of time to give the pipeline to complete. This includes the
1009
+ # time spent waiting for a worker to be allocated. If the pipeline fails to
1010
+ # complete before the timeout, it will be cancelled and the error code will be
1011
+ # set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.
1012
+ # Corresponds to the JSON property `timeout`
1013
+ # @return [String]
1014
+ attr_accessor :timeout
1015
+
1016
+ def initialize(**args)
1017
+ update!(**args)
1018
+ end
1019
+
1020
+ # Update properties of this object
1021
+ def update!(**args)
1022
+ @actions = args[:actions] if args.key?(:actions)
1023
+ @environment = args[:environment] if args.key?(:environment)
1024
+ @resources = args[:resources] if args.key?(:resources)
1025
+ @timeout = args[:timeout] if args.key?(:timeout)
1026
+ end
1027
+ end
1028
+
1029
+ # An event generated when the worker starts pulling an image.
1030
+ class PullStartedEvent
1031
+ include Google::Apis::Core::Hashable
1032
+
1033
+ # The URI of the image that was pulled.
1034
+ # Corresponds to the JSON property `imageUri`
1035
+ # @return [String]
1036
+ attr_accessor :image_uri
1037
+
1038
+ def initialize(**args)
1039
+ update!(**args)
1040
+ end
1041
+
1042
+ # Update properties of this object
1043
+ def update!(**args)
1044
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
1045
+ end
1046
+ end
1047
+
1048
+ # An event generated when the worker stops pulling an image.
1049
+ class PullStoppedEvent
1050
+ include Google::Apis::Core::Hashable
1051
+
1052
+ # The URI of the image that was pulled.
1053
+ # Corresponds to the JSON property `imageUri`
1054
+ # @return [String]
1055
+ attr_accessor :image_uri
1056
+
1057
+ def initialize(**args)
1058
+ update!(**args)
1059
+ end
1060
+
1061
+ # Update properties of this object
1062
+ def update!(**args)
1063
+ @image_uri = args[:image_uri] if args.key?(:image_uri)
1064
+ end
1065
+ end
1066
+
1067
+ # The system resources for the pipeline run. At least one zone or region must be
1068
+ # specified or the pipeline run will fail.
1069
+ class Resources
1070
+ include Google::Apis::Core::Hashable
1071
+
1072
+ # The project ID to allocate resources in.
1073
+ # Corresponds to the JSON property `projectId`
1074
+ # @return [String]
1075
+ attr_accessor :project_id
1076
+
1077
+ # The list of regions allowed for VM allocation. If set, the `zones` field must
1078
+ # not be set.
1079
+ # Corresponds to the JSON property `regions`
1080
+ # @return [Array<String>]
1081
+ attr_accessor :regions
1082
+
1083
+ # Carries information about a Compute Engine VM resource.
1084
+ # Corresponds to the JSON property `virtualMachine`
1085
+ # @return [Google::Apis::GenomicsV2alpha1::VirtualMachine]
1086
+ attr_accessor :virtual_machine
1087
+
1088
+ # The list of zones allowed for VM allocation. If set, the `regions` field must
1089
+ # not be set.
1090
+ # Corresponds to the JSON property `zones`
1091
+ # @return [Array<String>]
1092
+ attr_accessor :zones
1093
+
1094
+ def initialize(**args)
1095
+ update!(**args)
1096
+ end
1097
+
1098
+ # Update properties of this object
1099
+ def update!(**args)
1100
+ @project_id = args[:project_id] if args.key?(:project_id)
1101
+ @regions = args[:regions] if args.key?(:regions)
1102
+ @virtual_machine = args[:virtual_machine] if args.key?(:virtual_machine)
1103
+ @zones = args[:zones] if args.key?(:zones)
1104
+ end
1105
+ end
1106
+
1107
+ # The arguments to the `RunPipeline` method. The requesting user must have the `
1108
+ # iam.serviceAccounts.actAs` permission for the Cloud Genomics service account
1109
+ # or the request will fail.
1110
+ class RunPipelineRequest
1111
+ include Google::Apis::Core::Hashable
1112
+
1113
+ # User-defined labels to associate with the returned operation. These labels are
1114
+ # not propagated to any Google Cloud Platform resources used by the operation,
1115
+ # and can be modified at any time. To associate labels with resources created
1116
+ # while executing the operation, see the appropriate resource message (for
1117
+ # example, `VirtualMachine`).
1118
+ # Corresponds to the JSON property `labels`
1119
+ # @return [Hash<String,String>]
1120
+ attr_accessor :labels
1121
+
1122
+ # Specifies a series of actions to execute, expressed as Docker containers.
1123
+ # Corresponds to the JSON property `pipeline`
1124
+ # @return [Google::Apis::GenomicsV2alpha1::Pipeline]
1125
+ attr_accessor :pipeline
1126
+
1127
+ def initialize(**args)
1128
+ update!(**args)
1129
+ end
1130
+
1131
+ # Update properties of this object
1132
+ def update!(**args)
1133
+ @labels = args[:labels] if args.key?(:labels)
1134
+ @pipeline = args[:pipeline] if args.key?(:pipeline)
1135
+ end
1136
+ end
1137
+
1138
+ # The response to the RunPipeline method, returned in the operation's result
1139
+ # field on success.
1140
+ class RunPipelineResponse
1141
+ include Google::Apis::Core::Hashable
1142
+
1143
+ def initialize(**args)
1144
+ update!(**args)
1145
+ end
1146
+
1147
+ # Update properties of this object
1148
+ def update!(**args)
1149
+ end
1150
+ end
1151
+
1152
+ # Runtime metadata that will be populated in the runtimeMetadata field of the
1153
+ # Operation associated with a RunPipeline execution.
1154
+ class RuntimeMetadata
1155
+ include Google::Apis::Core::Hashable
1156
+
1157
+ # Describes a Compute Engine resource that is being managed by a running
1158
+ # pipeline.
1159
+ # Corresponds to the JSON property `computeEngine`
1160
+ # @return [Google::Apis::GenomicsV2alpha1::ComputeEngine]
1161
+ attr_accessor :compute_engine
1162
+
1163
+ def initialize(**args)
1164
+ update!(**args)
1165
+ end
1166
+
1167
+ # Update properties of this object
1168
+ def update!(**args)
1169
+ @compute_engine = args[:compute_engine] if args.key?(:compute_engine)
1170
+ end
1171
+ end
1172
+
1173
+ # Holds encrypted information that is only decrypted and stored in RAM by the
1174
+ # worker VM when running the pipeline.
1175
+ class Secret
1176
+ include Google::Apis::Core::Hashable
1177
+
1178
+ # The value of the cipherText response from the `encrypt` method. This field is
1179
+ # intentionally unaudited.
1180
+ # Corresponds to the JSON property `cipherText`
1181
+ # @return [String]
1182
+ attr_accessor :cipher_text
1183
+
1184
+ # The name of the Cloud KMS key that will be used to decrypt the secret value.
1185
+ # The VM service account must have the required permissions and authentication
1186
+ # scopes to invoke the `decrypt` method on the specified key.
1187
+ # Corresponds to the JSON property `keyName`
1188
+ # @return [String]
1189
+ attr_accessor :key_name
1190
+
1191
+ def initialize(**args)
1192
+ update!(**args)
1193
+ end
1194
+
1195
+ # Update properties of this object
1196
+ def update!(**args)
1197
+ @cipher_text = args[:cipher_text] if args.key?(:cipher_text)
1198
+ @key_name = args[:key_name] if args.key?(:key_name)
1199
+ end
1200
+ end
1201
+
1202
+ # Carries information about a Google Cloud service account.
1203
+ class ServiceAccount
1204
+ include Google::Apis::Core::Hashable
1205
+
1206
+ # Email address of the service account. If not specified, the default Compute
1207
+ # Engine service account for the project will be used.
1208
+ # Corresponds to the JSON property `email`
1209
+ # @return [String]
1210
+ attr_accessor :email
1211
+
1212
+ # List of scopes to be enabled for this service account on the VM, in addition
1213
+ # to the cloud-platform API scope that will be added by default.
1214
+ # Corresponds to the JSON property `scopes`
1215
+ # @return [Array<String>]
1216
+ attr_accessor :scopes
1217
+
1218
+ def initialize(**args)
1219
+ update!(**args)
1220
+ end
1221
+
1222
+ # Update properties of this object
1223
+ def update!(**args)
1224
+ @email = args[:email] if args.key?(:email)
1225
+ @scopes = args[:scopes] if args.key?(:scopes)
1226
+ end
1227
+ end
1228
+
1229
+ # The `Status` type defines a logical error model that is suitable for different
1230
+ # programming environments, including REST APIs and RPC APIs. It is used by [
1231
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
1232
+ # data: error code, error message, and error details. You can find out more
1233
+ # about this error model and how to work with it in the [API Design Guide](https:
1234
+ # //cloud.google.com/apis/design/errors).
1235
+ class Status
1236
+ include Google::Apis::Core::Hashable
1237
+
1238
+ # The status code, which should be an enum value of google.rpc.Code.
1239
+ # Corresponds to the JSON property `code`
1240
+ # @return [Fixnum]
1241
+ attr_accessor :code
1242
+
1243
+ # A list of messages that carry the error details. There is a common set of
1244
+ # message types for APIs to use.
1245
+ # Corresponds to the JSON property `details`
1246
+ # @return [Array<Hash<String,Object>>]
1247
+ attr_accessor :details
1248
+
1249
+ # A developer-facing error message, which should be in English. Any user-facing
1250
+ # error message should be localized and sent in the google.rpc.Status.details
1251
+ # field, or localized by the client.
1252
+ # Corresponds to the JSON property `message`
1253
+ # @return [String]
1254
+ attr_accessor :message
1255
+
1256
+ def initialize(**args)
1257
+ update!(**args)
1258
+ end
1259
+
1260
+ # Update properties of this object
1261
+ def update!(**args)
1262
+ @code = args[:code] if args.key?(:code)
1263
+ @details = args[:details] if args.key?(:details)
1264
+ @message = args[:message] if args.key?(:message)
1265
+ end
1266
+ end
1267
+
1268
+ # An event that occured in the operation assigned to the worker and the time of
1269
+ # occurance.
1270
+ class TimestampedEvent
1271
+ include Google::Apis::Core::Hashable
1272
+
1273
+ # The event data.
1274
+ # Corresponds to the JSON property `data`
1275
+ # @return [Hash<String,Object>]
1276
+ attr_accessor :data
1277
+
1278
+ # The time when the event happened.
1279
+ # Corresponds to the JSON property `timestamp`
1280
+ # @return [String]
1281
+ attr_accessor :timestamp
1282
+
1283
+ def initialize(**args)
1284
+ update!(**args)
1285
+ end
1286
+
1287
+ # Update properties of this object
1288
+ def update!(**args)
1289
+ @data = args[:data] if args.key?(:data)
1290
+ @timestamp = args[:timestamp] if args.key?(:timestamp)
1291
+ end
1292
+ end
1293
+
1294
+ # An event generated when the execution of a container results in a non-zero
1295
+ # exit status that was not otherwise ignored. Execution will continue, but only
1296
+ # actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will
1297
+ # be skipped.
1298
+ class UnexpectedExitStatusEvent
1299
+ include Google::Apis::Core::Hashable
1300
+
1301
+ # The numeric ID of the action that started the container.
1302
+ # Corresponds to the JSON property `actionId`
1303
+ # @return [Fixnum]
1304
+ attr_accessor :action_id
1305
+
1306
+ # The exit status of the container.
1307
+ # Corresponds to the JSON property `exitStatus`
1308
+ # @return [Fixnum]
1309
+ attr_accessor :exit_status
1310
+
1311
+ def initialize(**args)
1312
+ update!(**args)
1313
+ end
1314
+
1315
+ # Update properties of this object
1316
+ def update!(**args)
1317
+ @action_id = args[:action_id] if args.key?(:action_id)
1318
+ @exit_status = args[:exit_status] if args.key?(:exit_status)
1319
+ end
1320
+ end
1321
+
1322
+ # Carries information about a Compute Engine VM resource.
1323
+ class VirtualMachine
1324
+ include Google::Apis::Core::Hashable
1325
+
1326
+ # The list of accelerators to attach to the VM.
1327
+ # Corresponds to the JSON property `accelerators`
1328
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Accelerator>]
1329
+ attr_accessor :accelerators
1330
+
1331
+ # The size of the boot disk, in GB. The boot disk must be large enough to
1332
+ # accommodate all of the Docker images from each action in the pipeline at the
1333
+ # same time. If not specified, a small but reasonable default value is used.
1334
+ # Corresponds to the JSON property `bootDiskSizeGb`
1335
+ # @return [Fixnum]
1336
+ attr_accessor :boot_disk_size_gb
1337
+
1338
+ # The host operating system image to use. Currently, only Container-Optimized OS
1339
+ # images can be used. The default value is `projects/cos-cloud/global/images/
1340
+ # family/cos-stable`, which selects the latest stable release of Container-
1341
+ # Optimized OS. This option is provided to allow testing against the beta
1342
+ # release of the operating system to ensure that the new version does not
1343
+ # interact negatively with production pipelines. To test a pipeline against the
1344
+ # beta release of Container-Optimized OS, use the value `projects/cos-cloud/
1345
+ # global/images/family/cos-beta`.
1346
+ # Corresponds to the JSON property `bootImage`
1347
+ # @return [String]
1348
+ attr_accessor :boot_image
1349
+
1350
+ # The CPU platform to request. An instance based on a newer platform can be
1351
+ # allocated, but never one with fewer capabilities. The value of this parameter
1352
+ # must be a valid Compute Engine CPU platform name (such as "Intel Skylake").
1353
+ # This parameter is only useful for carefully optimized work loads where the CPU
1354
+ # platform has a significant impact. For more information about the effect of
1355
+ # this parameter, see https://cloud.google.com/compute/docs/instances/specify-
1356
+ # min-cpu-platform.
1357
+ # Corresponds to the JSON property `cpuPlatform`
1358
+ # @return [String]
1359
+ attr_accessor :cpu_platform
1360
+
1361
+ # The list of disks to create and attach to the VM. Specify either the `volumes[]
1362
+ # ` field or the `disks[]` field, but not both.
1363
+ # Corresponds to the JSON property `disks`
1364
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Disk>]
1365
+ attr_accessor :disks
1366
+
1367
+ # The Compute Engine Disk Images to use as a Docker cache. The disks will be
1368
+ # mounted into the Docker folder in a way that the images present in the cache
1369
+ # will not need to be pulled. The digests of the cached images must match those
1370
+ # of the tags used or the latest version will still be pulled. The root
1371
+ # directory of the ext4 image must contain `image` and `overlay2` directories
1372
+ # copied from the Docker directory of a VM where the desired Docker images have
1373
+ # already been pulled. Only a single image is supported.
1374
+ # Corresponds to the JSON property `dockerCacheImages`
1375
+ # @return [Array<String>]
1376
+ attr_accessor :docker_cache_images
1377
+
1378
+ # Whether Stackdriver monitoring should be enabled on the VM.
1379
+ # Corresponds to the JSON property `enableStackdriverMonitoring`
1380
+ # @return [Boolean]
1381
+ attr_accessor :enable_stackdriver_monitoring
1382
+ alias_method :enable_stackdriver_monitoring?, :enable_stackdriver_monitoring
1383
+
1384
+ # Optional set of labels to apply to the VM and any attached disk resources.
1385
+ # These labels must adhere to the [name and value restrictions](https://cloud.
1386
+ # google.com/compute/docs/labeling-resources) on VM labels imposed by Compute
1387
+ # Engine. Labels keys with the prefix 'google-' are reserved for use by Google.
1388
+ # Labels applied at creation time to the VM. Applied on a best-effort basis to
1389
+ # attached disk resources shortly after VM creation.
1390
+ # Corresponds to the JSON property `labels`
1391
+ # @return [Hash<String,String>]
1392
+ attr_accessor :labels
1393
+
1394
+ # Required. The machine type of the virtual machine to create. Must be the short
1395
+ # name of a standard machine type (such as "n1-standard-1") or a custom machine
1396
+ # type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "
1397
+ # 4096" indicates the memory in MB). See [Creating an instance with a custom
1398
+ # machine type](https://cloud.google.com/compute/docs/instances/creating-
1399
+ # instance-with-custom-machine-type#create) for more specifications on creating
1400
+ # a custom machine type.
1401
+ # Corresponds to the JSON property `machineType`
1402
+ # @return [String]
1403
+ attr_accessor :machine_type
1404
+
1405
+ # VM networking options.
1406
+ # Corresponds to the JSON property `network`
1407
+ # @return [Google::Apis::GenomicsV2alpha1::Network]
1408
+ attr_accessor :network
1409
+
1410
+ # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The
1411
+ # version specified here must be compatible with the GPU libraries contained in
1412
+ # the container being executed, and must be one of the drivers hosted in the `
1413
+ # nvidia-drivers-us-public` bucket on Google Cloud Storage.
1414
+ # Corresponds to the JSON property `nvidiaDriverVersion`
1415
+ # @return [String]
1416
+ attr_accessor :nvidia_driver_version
1417
+
1418
+ # If true, allocate a preemptible VM.
1419
+ # Corresponds to the JSON property `preemptible`
1420
+ # @return [Boolean]
1421
+ attr_accessor :preemptible
1422
+ alias_method :preemptible?, :preemptible
1423
+
1424
+ # Carries information about a Google Cloud service account.
1425
+ # Corresponds to the JSON property `serviceAccount`
1426
+ # @return [Google::Apis::GenomicsV2alpha1::ServiceAccount]
1427
+ attr_accessor :service_account
1428
+
1429
+ # The list of disks and other storage to create or attach to the VM. Specify
1430
+ # either the `volumes[]` field or the `disks[]` field, but not both.
1431
+ # Corresponds to the JSON property `volumes`
1432
+ # @return [Array<Google::Apis::GenomicsV2alpha1::Volume>]
1433
+ attr_accessor :volumes
1434
+
1435
+ def initialize(**args)
1436
+ update!(**args)
1437
+ end
1438
+
1439
+ # Update properties of this object
1440
+ def update!(**args)
1441
+ @accelerators = args[:accelerators] if args.key?(:accelerators)
1442
+ @boot_disk_size_gb = args[:boot_disk_size_gb] if args.key?(:boot_disk_size_gb)
1443
+ @boot_image = args[:boot_image] if args.key?(:boot_image)
1444
+ @cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform)
1445
+ @disks = args[:disks] if args.key?(:disks)
1446
+ @docker_cache_images = args[:docker_cache_images] if args.key?(:docker_cache_images)
1447
+ @enable_stackdriver_monitoring = args[:enable_stackdriver_monitoring] if args.key?(:enable_stackdriver_monitoring)
1448
+ @labels = args[:labels] if args.key?(:labels)
1449
+ @machine_type = args[:machine_type] if args.key?(:machine_type)
1450
+ @network = args[:network] if args.key?(:network)
1451
+ @nvidia_driver_version = args[:nvidia_driver_version] if args.key?(:nvidia_driver_version)
1452
+ @preemptible = args[:preemptible] if args.key?(:preemptible)
1453
+ @service_account = args[:service_account] if args.key?(:service_account)
1454
+ @volumes = args[:volumes] if args.key?(:volumes)
1455
+ end
1456
+ end
1457
+
1458
+ # Carries information about storage that can be attached to a VM. Specify either
1459
+ # `Volume` or `Disk`, but not both.
1460
+ class Volume
1461
+ include Google::Apis::Core::Hashable
1462
+
1463
+ # Configuration for an existing disk to be attached to the VM.
1464
+ # Corresponds to the JSON property `existingDisk`
1465
+ # @return [Google::Apis::GenomicsV2alpha1::ExistingDisk]
1466
+ attr_accessor :existing_disk
1467
+
1468
+ # Configuration for an `NFSMount` to be attached to the VM.
1469
+ # Corresponds to the JSON property `nfsMount`
1470
+ # @return [Google::Apis::GenomicsV2alpha1::NfsMount]
1471
+ attr_accessor :nfs_mount
1472
+
1473
+ # Configuration for a persistent disk to be attached to the VM. See https://
1474
+ # cloud.google.com/compute/docs/disks/performance for more information about
1475
+ # disk type, size, and performance considerations.
1476
+ # Corresponds to the JSON property `persistentDisk`
1477
+ # @return [Google::Apis::GenomicsV2alpha1::PersistentDisk]
1478
+ attr_accessor :persistent_disk
1479
+
1480
+ # A user-supplied name for the volume. Used when mounting the volume into `
1481
+ # Actions`. The name must contain only upper and lowercase alphanumeric
1482
+ # characters and hyphens and cannot start with a hyphen.
1483
+ # Corresponds to the JSON property `volume`
1484
+ # @return [String]
1485
+ attr_accessor :volume
1486
+
1487
+ def initialize(**args)
1488
+ update!(**args)
1489
+ end
1490
+
1491
+ # Update properties of this object
1492
+ def update!(**args)
1493
+ @existing_disk = args[:existing_disk] if args.key?(:existing_disk)
1494
+ @nfs_mount = args[:nfs_mount] if args.key?(:nfs_mount)
1495
+ @persistent_disk = args[:persistent_disk] if args.key?(:persistent_disk)
1496
+ @volume = args[:volume] if args.key?(:volume)
1497
+ end
1498
+ end
1499
+
1500
+ # An event generated after a worker VM has been assigned to run the pipeline.
1501
+ class WorkerAssignedEvent
1502
+ include Google::Apis::Core::Hashable
1503
+
1504
+ # The worker's instance name.
1505
+ # Corresponds to the JSON property `instance`
1506
+ # @return [String]
1507
+ attr_accessor :instance
1508
+
1509
+ # The machine type that was assigned for the worker.
1510
+ # Corresponds to the JSON property `machineType`
1511
+ # @return [String]
1512
+ attr_accessor :machine_type
1513
+
1514
+ # The zone the worker is running in.
1515
+ # Corresponds to the JSON property `zone`
1516
+ # @return [String]
1517
+ attr_accessor :zone
1518
+
1519
+ def initialize(**args)
1520
+ update!(**args)
1521
+ end
1522
+
1523
+ # Update properties of this object
1524
+ def update!(**args)
1525
+ @instance = args[:instance] if args.key?(:instance)
1526
+ @machine_type = args[:machine_type] if args.key?(:machine_type)
1527
+ @zone = args[:zone] if args.key?(:zone)
1528
+ end
1529
+ end
1530
+
1531
+ # An event generated when the worker VM that was assigned to the pipeline has
1532
+ # been released (deleted).
1533
+ class WorkerReleasedEvent
1534
+ include Google::Apis::Core::Hashable
1535
+
1536
+ # The worker's instance name.
1537
+ # Corresponds to the JSON property `instance`
1538
+ # @return [String]
1539
+ attr_accessor :instance
1540
+
1541
+ # The zone the worker was running in.
1542
+ # Corresponds to the JSON property `zone`
1543
+ # @return [String]
1544
+ attr_accessor :zone
1545
+
1546
+ def initialize(**args)
1547
+ update!(**args)
1548
+ end
1549
+
1550
+ # Update properties of this object
1551
+ def update!(**args)
1552
+ @instance = args[:instance] if args.key?(:instance)
1553
+ @zone = args[:zone] if args.key?(:zone)
1554
+ end
1555
+ end
1556
+
1557
+ # The status of the worker VM.
1558
+ class WorkerStatus
1559
+ include Google::Apis::Core::Hashable
1560
+
1561
+ # Status of attached disks.
1562
+ # Corresponds to the JSON property `attachedDisks`
1563
+ # @return [Hash<String,Google::Apis::GenomicsV2alpha1::DiskStatus>]
1564
+ attr_accessor :attached_disks
1565
+
1566
+ # The status of a disk on a VM.
1567
+ # Corresponds to the JSON property `bootDisk`
1568
+ # @return [Google::Apis::GenomicsV2alpha1::DiskStatus]
1569
+ attr_accessor :boot_disk
1570
+
1571
+ # Free RAM.
1572
+ # Corresponds to the JSON property `freeRamBytes`
1573
+ # @return [Fixnum]
1574
+ attr_accessor :free_ram_bytes
1575
+
1576
+ # Total RAM.
1577
+ # Corresponds to the JSON property `totalRamBytes`
1578
+ # @return [Fixnum]
1579
+ attr_accessor :total_ram_bytes
1580
+
1581
+ # System uptime.
1582
+ # Corresponds to the JSON property `uptimeSeconds`
1583
+ # @return [Fixnum]
1584
+ attr_accessor :uptime_seconds
1585
+
1586
+ def initialize(**args)
1587
+ update!(**args)
1588
+ end
1589
+
1590
+ # Update properties of this object
1591
+ def update!(**args)
1592
+ @attached_disks = args[:attached_disks] if args.key?(:attached_disks)
1593
+ @boot_disk = args[:boot_disk] if args.key?(:boot_disk)
1594
+ @free_ram_bytes = args[:free_ram_bytes] if args.key?(:free_ram_bytes)
1595
+ @total_ram_bytes = args[:total_ram_bytes] if args.key?(:total_ram_bytes)
1596
+ @uptime_seconds = args[:uptime_seconds] if args.key?(:uptime_seconds)
1597
+ end
1598
+ end
1599
+ end
1600
+ end
1601
+ end