google-apis-bigtableadmin_v1 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: 98d8f1552f2ca478277f1c015e104e16999d4ac873508700860980ae37d29efd
4
+ data.tar.gz: 6baa595066b5f0ecea894132114369323e055d4d78c5445bf18607a4759cb1e5
5
+ SHA512:
6
+ metadata.gz: 7c53070f6eecae80ad77fdc7fa74b487545f886e4f283f6ffc9a91dc35ca40f4d8ec7b8d9df597145c37fbc850c7d140c37ecfa80cd9b79adbaa99203f9cc3aa
7
+ data.tar.gz: 4274140007651531340b30636f395c44468c21bed5b6003acebec457c096286a4e7a5e2258087aec910040ec47f957f6c7f59e91af0f849ed32d968a503c744a
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-bigtableadmin_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/bigtableadmin_v1/*.rb
9
+ lib/google/apis/bigtableadmin_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-bigtableadmin_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20200821
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 V1 of the Cloud Bigtable Admin API
2
+
3
+ This is a simple client library for version V1 of the Cloud Bigtable Admin 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/bigtableadmin.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-bigtableadmin_v1', '~> 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-bigtableadmin_v1
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/bigtableadmin_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::BigtableadminV1::BigtableAdminService.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 Bigtableadmin service in particular.)
67
+
68
+ For reference information on specific calls in the Cloud Bigtable Admin API, see the {Google::Apis::BigtableadminV1::BigtableAdminService 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-bigtableadmin_v1`, 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/bigtable/) 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/bigtableadmin_v1"
@@ -0,0 +1,33 @@
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/bigtableadmin_v1/service.rb'
16
+ require 'google/apis/bigtableadmin_v1/classes.rb'
17
+ require 'google/apis/bigtableadmin_v1/representations.rb'
18
+ require 'google/apis/bigtableadmin_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Cloud Bigtable Admin API
23
+ #
24
+ # Administer your Cloud Bigtable tables and instances.
25
+ #
26
+ # @see https://cloud.google.com/bigtable/
27
+ module BigtableadminV1
28
+ # Version of the Cloud Bigtable Admin API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,721 @@
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 BigtableadminV1
24
+
25
+ # A backup of a Cloud Bigtable table.
26
+ class Backup
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Output only. `end_time` is the time that the backup was finished. The row data
30
+ # in the backup will be no newer than this timestamp.
31
+ # Corresponds to the JSON property `endTime`
32
+ # @return [String]
33
+ attr_accessor :end_time
34
+
35
+ # Required. The expiration time of the backup, with microseconds granularity
36
+ # that must be at least 6 hours and at most 30 days from the time the request is
37
+ # received. Once the `expire_time` has passed, Cloud Bigtable will delete the
38
+ # backup and free the resources used by the backup.
39
+ # Corresponds to the JSON property `expireTime`
40
+ # @return [String]
41
+ attr_accessor :expire_time
42
+
43
+ # A globally unique identifier for the backup which cannot be changed. Values
44
+ # are of the form `projects/`project`/instances/`instance`/clusters/`cluster`/
45
+ # backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50
46
+ # characters in length. The backup is stored in the cluster identified by the
47
+ # prefix of the backup name of the form `projects/`project`/instances/`instance`/
48
+ # clusters/`cluster``.
49
+ # Corresponds to the JSON property `name`
50
+ # @return [String]
51
+ attr_accessor :name
52
+
53
+ # Output only. Size of the backup in bytes.
54
+ # Corresponds to the JSON property `sizeBytes`
55
+ # @return [Fixnum]
56
+ attr_accessor :size_bytes
57
+
58
+ # Required. Immutable. Name of the table from which this backup was created.
59
+ # This needs to be in the same instance as the backup. Values are of the form `
60
+ # projects/`project`/instances/`instance`/tables/`source_table``.
61
+ # Corresponds to the JSON property `sourceTable`
62
+ # @return [String]
63
+ attr_accessor :source_table
64
+
65
+ # Output only. `start_time` is the time that the backup was started (i.e.
66
+ # approximately the time the CreateBackup request is received). The row data in
67
+ # this backup will be no older than this timestamp.
68
+ # Corresponds to the JSON property `startTime`
69
+ # @return [String]
70
+ attr_accessor :start_time
71
+
72
+ # Output only. The current state of the backup.
73
+ # Corresponds to the JSON property `state`
74
+ # @return [String]
75
+ attr_accessor :state
76
+
77
+ def initialize(**args)
78
+ update!(**args)
79
+ end
80
+
81
+ # Update properties of this object
82
+ def update!(**args)
83
+ @end_time = args[:end_time] if args.key?(:end_time)
84
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
85
+ @name = args[:name] if args.key?(:name)
86
+ @size_bytes = args[:size_bytes] if args.key?(:size_bytes)
87
+ @source_table = args[:source_table] if args.key?(:source_table)
88
+ @start_time = args[:start_time] if args.key?(:start_time)
89
+ @state = args[:state] if args.key?(:state)
90
+ end
91
+ end
92
+
93
+ # Information about a backup.
94
+ class BackupInfo
95
+ include Google::Apis::Core::Hashable
96
+
97
+ # Output only. Name of the backup.
98
+ # Corresponds to the JSON property `backup`
99
+ # @return [String]
100
+ attr_accessor :backup
101
+
102
+ # Output only. This time that the backup was finished. Row data in the backup
103
+ # will be no newer than this timestamp.
104
+ # Corresponds to the JSON property `endTime`
105
+ # @return [String]
106
+ attr_accessor :end_time
107
+
108
+ # Output only. Name of the table the backup was created from.
109
+ # Corresponds to the JSON property `sourceTable`
110
+ # @return [String]
111
+ attr_accessor :source_table
112
+
113
+ # Output only. The time that the backup was started. Row data in the backup will
114
+ # be no older than this timestamp.
115
+ # Corresponds to the JSON property `startTime`
116
+ # @return [String]
117
+ attr_accessor :start_time
118
+
119
+ def initialize(**args)
120
+ update!(**args)
121
+ end
122
+
123
+ # Update properties of this object
124
+ def update!(**args)
125
+ @backup = args[:backup] if args.key?(:backup)
126
+ @end_time = args[:end_time] if args.key?(:end_time)
127
+ @source_table = args[:source_table] if args.key?(:source_table)
128
+ @start_time = args[:start_time] if args.key?(:start_time)
129
+ end
130
+ end
131
+
132
+ # A resizable group of nodes in a particular cloud location, capable of serving
133
+ # all Tables in the parent Instance.
134
+ class Cluster
135
+ include Google::Apis::Core::Hashable
136
+
137
+ # Immutable. The type of storage used by this cluster to serve its parent
138
+ # instance's tables, unless explicitly overridden.
139
+ # Corresponds to the JSON property `defaultStorageType`
140
+ # @return [String]
141
+ attr_accessor :default_storage_type
142
+
143
+ # Immutable. The location where this cluster's nodes and storage reside. For
144
+ # best performance, clients should be located as close as possible to this
145
+ # cluster. Currently only zones are supported, so values should be of the form `
146
+ # projects/`project`/locations/`zone``.
147
+ # Corresponds to the JSON property `location`
148
+ # @return [String]
149
+ attr_accessor :location
150
+
151
+ # The unique name of the cluster. Values are of the form `projects/`project`/
152
+ # instances/`instance`/clusters/a-z*`.
153
+ # Corresponds to the JSON property `name`
154
+ # @return [String]
155
+ attr_accessor :name
156
+
157
+ # Required. The number of nodes allocated to this cluster. More nodes enable
158
+ # higher throughput and more consistent performance.
159
+ # Corresponds to the JSON property `serveNodes`
160
+ # @return [Fixnum]
161
+ attr_accessor :serve_nodes
162
+
163
+ # Output only. The current state of the cluster.
164
+ # Corresponds to the JSON property `state`
165
+ # @return [String]
166
+ attr_accessor :state
167
+
168
+ def initialize(**args)
169
+ update!(**args)
170
+ end
171
+
172
+ # Update properties of this object
173
+ def update!(**args)
174
+ @default_storage_type = args[:default_storage_type] if args.key?(:default_storage_type)
175
+ @location = args[:location] if args.key?(:location)
176
+ @name = args[:name] if args.key?(:name)
177
+ @serve_nodes = args[:serve_nodes] if args.key?(:serve_nodes)
178
+ @state = args[:state] if args.key?(:state)
179
+ end
180
+ end
181
+
182
+ # Metadata type for the operation returned by CreateBackup.
183
+ class CreateBackupMetadata
184
+ include Google::Apis::Core::Hashable
185
+
186
+ # If set, the time at which this operation finished or was cancelled.
187
+ # Corresponds to the JSON property `endTime`
188
+ # @return [String]
189
+ attr_accessor :end_time
190
+
191
+ # The name of the backup being created.
192
+ # Corresponds to the JSON property `name`
193
+ # @return [String]
194
+ attr_accessor :name
195
+
196
+ # The name of the table the backup is created from.
197
+ # Corresponds to the JSON property `sourceTable`
198
+ # @return [String]
199
+ attr_accessor :source_table
200
+
201
+ # The time at which this operation started.
202
+ # Corresponds to the JSON property `startTime`
203
+ # @return [String]
204
+ attr_accessor :start_time
205
+
206
+ def initialize(**args)
207
+ update!(**args)
208
+ end
209
+
210
+ # Update properties of this object
211
+ def update!(**args)
212
+ @end_time = args[:end_time] if args.key?(:end_time)
213
+ @name = args[:name] if args.key?(:name)
214
+ @source_table = args[:source_table] if args.key?(:source_table)
215
+ @start_time = args[:start_time] if args.key?(:start_time)
216
+ end
217
+ end
218
+
219
+ # The metadata for the Operation returned by CreateCluster.
220
+ class CreateClusterMetadata
221
+ include Google::Apis::Core::Hashable
222
+
223
+ # The time at which the operation failed or was completed successfully.
224
+ # Corresponds to the JSON property `finishTime`
225
+ # @return [String]
226
+ attr_accessor :finish_time
227
+
228
+ # Request message for BigtableInstanceAdmin.CreateCluster.
229
+ # Corresponds to the JSON property `originalRequest`
230
+ # @return [Google::Apis::BigtableadminV1::CreateClusterRequest]
231
+ attr_accessor :original_request
232
+
233
+ # The time at which the original request was received.
234
+ # Corresponds to the JSON property `requestTime`
235
+ # @return [String]
236
+ attr_accessor :request_time
237
+
238
+ # Keys: the full `name` of each table that existed in the instance when
239
+ # CreateCluster was first called, i.e. `projects//instances//tables/`. Any table
240
+ # added to the instance by a later API call will be created in the new cluster
241
+ # by that API call, not this one. Values: information on how much of a table's
242
+ # data has been copied to the newly-created cluster so far.
243
+ # Corresponds to the JSON property `tables`
244
+ # @return [Hash<String,Google::Apis::BigtableadminV1::TableProgress>]
245
+ attr_accessor :tables
246
+
247
+ def initialize(**args)
248
+ update!(**args)
249
+ end
250
+
251
+ # Update properties of this object
252
+ def update!(**args)
253
+ @finish_time = args[:finish_time] if args.key?(:finish_time)
254
+ @original_request = args[:original_request] if args.key?(:original_request)
255
+ @request_time = args[:request_time] if args.key?(:request_time)
256
+ @tables = args[:tables] if args.key?(:tables)
257
+ end
258
+ end
259
+
260
+ # Request message for BigtableInstanceAdmin.CreateCluster.
261
+ class CreateClusterRequest
262
+ include Google::Apis::Core::Hashable
263
+
264
+ # A resizable group of nodes in a particular cloud location, capable of serving
265
+ # all Tables in the parent Instance.
266
+ # Corresponds to the JSON property `cluster`
267
+ # @return [Google::Apis::BigtableadminV1::Cluster]
268
+ attr_accessor :cluster
269
+
270
+ # Required. The ID to be used when referring to the new cluster within its
271
+ # instance, e.g., just `mycluster` rather than `projects/myproject/instances/
272
+ # myinstance/clusters/mycluster`.
273
+ # Corresponds to the JSON property `clusterId`
274
+ # @return [String]
275
+ attr_accessor :cluster_id
276
+
277
+ # Required. The unique name of the instance in which to create the new cluster.
278
+ # Values are of the form `projects/`project`/instances/`instance``.
279
+ # Corresponds to the JSON property `parent`
280
+ # @return [String]
281
+ attr_accessor :parent
282
+
283
+ def initialize(**args)
284
+ update!(**args)
285
+ end
286
+
287
+ # Update properties of this object
288
+ def update!(**args)
289
+ @cluster = args[:cluster] if args.key?(:cluster)
290
+ @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
291
+ @parent = args[:parent] if args.key?(:parent)
292
+ end
293
+ end
294
+
295
+ # The metadata for the Operation returned by CreateInstance.
296
+ class CreateInstanceMetadata
297
+ include Google::Apis::Core::Hashable
298
+
299
+ # The time at which the operation failed or was completed successfully.
300
+ # Corresponds to the JSON property `finishTime`
301
+ # @return [String]
302
+ attr_accessor :finish_time
303
+
304
+ # Request message for BigtableInstanceAdmin.CreateInstance.
305
+ # Corresponds to the JSON property `originalRequest`
306
+ # @return [Google::Apis::BigtableadminV1::CreateInstanceRequest]
307
+ attr_accessor :original_request
308
+
309
+ # The time at which the original request was received.
310
+ # Corresponds to the JSON property `requestTime`
311
+ # @return [String]
312
+ attr_accessor :request_time
313
+
314
+ def initialize(**args)
315
+ update!(**args)
316
+ end
317
+
318
+ # Update properties of this object
319
+ def update!(**args)
320
+ @finish_time = args[:finish_time] if args.key?(:finish_time)
321
+ @original_request = args[:original_request] if args.key?(:original_request)
322
+ @request_time = args[:request_time] if args.key?(:request_time)
323
+ end
324
+ end
325
+
326
+ # Request message for BigtableInstanceAdmin.CreateInstance.
327
+ class CreateInstanceRequest
328
+ include Google::Apis::Core::Hashable
329
+
330
+ # Required. The clusters to be created within the instance, mapped by desired
331
+ # cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/
332
+ # myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank.
333
+ # Currently, at most four clusters can be specified.
334
+ # Corresponds to the JSON property `clusters`
335
+ # @return [Hash<String,Google::Apis::BigtableadminV1::Cluster>]
336
+ attr_accessor :clusters
337
+
338
+ # A collection of Bigtable Tables and the resources that serve them. All tables
339
+ # in an instance are served from all Clusters in the instance.
340
+ # Corresponds to the JSON property `instance`
341
+ # @return [Google::Apis::BigtableadminV1::Instance]
342
+ attr_accessor :instance
343
+
344
+ # Required. The ID to be used when referring to the new instance within its
345
+ # project, e.g., just `myinstance` rather than `projects/myproject/instances/
346
+ # myinstance`.
347
+ # Corresponds to the JSON property `instanceId`
348
+ # @return [String]
349
+ attr_accessor :instance_id
350
+
351
+ # Required. The unique name of the project in which to create the new instance.
352
+ # Values are of the form `projects/`project``.
353
+ # Corresponds to the JSON property `parent`
354
+ # @return [String]
355
+ attr_accessor :parent
356
+
357
+ def initialize(**args)
358
+ update!(**args)
359
+ end
360
+
361
+ # Update properties of this object
362
+ def update!(**args)
363
+ @clusters = args[:clusters] if args.key?(:clusters)
364
+ @instance = args[:instance] if args.key?(:instance)
365
+ @instance_id = args[:instance_id] if args.key?(:instance_id)
366
+ @parent = args[:parent] if args.key?(:parent)
367
+ end
368
+ end
369
+
370
+ # Added to the error payload.
371
+ class FailureTrace
372
+ include Google::Apis::Core::Hashable
373
+
374
+ #
375
+ # Corresponds to the JSON property `frames`
376
+ # @return [Array<Google::Apis::BigtableadminV1::Frame>]
377
+ attr_accessor :frames
378
+
379
+ def initialize(**args)
380
+ update!(**args)
381
+ end
382
+
383
+ # Update properties of this object
384
+ def update!(**args)
385
+ @frames = args[:frames] if args.key?(:frames)
386
+ end
387
+ end
388
+
389
+ #
390
+ class Frame
391
+ include Google::Apis::Core::Hashable
392
+
393
+ #
394
+ # Corresponds to the JSON property `targetName`
395
+ # @return [String]
396
+ attr_accessor :target_name
397
+
398
+ #
399
+ # Corresponds to the JSON property `workflowGuid`
400
+ # @return [String]
401
+ attr_accessor :workflow_guid
402
+
403
+ #
404
+ # Corresponds to the JSON property `zoneId`
405
+ # @return [String]
406
+ attr_accessor :zone_id
407
+
408
+ def initialize(**args)
409
+ update!(**args)
410
+ end
411
+
412
+ # Update properties of this object
413
+ def update!(**args)
414
+ @target_name = args[:target_name] if args.key?(:target_name)
415
+ @workflow_guid = args[:workflow_guid] if args.key?(:workflow_guid)
416
+ @zone_id = args[:zone_id] if args.key?(:zone_id)
417
+ end
418
+ end
419
+
420
+ # A collection of Bigtable Tables and the resources that serve them. All tables
421
+ # in an instance are served from all Clusters in the instance.
422
+ class Instance
423
+ include Google::Apis::Core::Hashable
424
+
425
+ # Required. The descriptive name for this instance as it appears in UIs. Can be
426
+ # changed at any time, but should be kept globally unique to avoid confusion.
427
+ # Corresponds to the JSON property `displayName`
428
+ # @return [String]
429
+ attr_accessor :display_name
430
+
431
+ # Required. Labels are a flexible and lightweight mechanism for organizing cloud
432
+ # resources into groups that reflect a customer's organizational needs and
433
+ # deployment strategies. They can be used to filter resources and aggregate
434
+ # metrics. * Label keys must be between 1 and 63 characters long and must
435
+ # conform to the regular expression: `\p`Ll`\p`Lo``0,62``. * Label values must
436
+ # be between 0 and 63 characters long and must conform to the regular expression:
437
+ # `[\p`Ll`\p`Lo`\p`N`_-]`0,63``. * No more than 64 labels can be associated
438
+ # with a given resource. * Keys and values must both be under 128 bytes.
439
+ # Corresponds to the JSON property `labels`
440
+ # @return [Hash<String,String>]
441
+ attr_accessor :labels
442
+
443
+ # The unique name of the instance. Values are of the form `projects/`project`/
444
+ # instances/a-z+[a-z0-9]`.
445
+ # Corresponds to the JSON property `name`
446
+ # @return [String]
447
+ attr_accessor :name
448
+
449
+ # Output only. The current state of the instance.
450
+ # Corresponds to the JSON property `state`
451
+ # @return [String]
452
+ attr_accessor :state
453
+
454
+ # Required. The type of the instance. Defaults to `PRODUCTION`.
455
+ # Corresponds to the JSON property `type`
456
+ # @return [String]
457
+ attr_accessor :type
458
+
459
+ def initialize(**args)
460
+ update!(**args)
461
+ end
462
+
463
+ # Update properties of this object
464
+ def update!(**args)
465
+ @display_name = args[:display_name] if args.key?(:display_name)
466
+ @labels = args[:labels] if args.key?(:labels)
467
+ @name = args[:name] if args.key?(:name)
468
+ @state = args[:state] if args.key?(:state)
469
+ @type = args[:type] if args.key?(:type)
470
+ end
471
+ end
472
+
473
+ # Encapsulates progress related information for a Cloud Bigtable long running
474
+ # operation.
475
+ class OperationProgress
476
+ include Google::Apis::Core::Hashable
477
+
478
+ # If set, the time at which this operation failed or was completed successfully.
479
+ # Corresponds to the JSON property `endTime`
480
+ # @return [String]
481
+ attr_accessor :end_time
482
+
483
+ # Percent completion of the operation. Values are between 0 and 100 inclusive.
484
+ # Corresponds to the JSON property `progressPercent`
485
+ # @return [Fixnum]
486
+ attr_accessor :progress_percent
487
+
488
+ # Time the request was received.
489
+ # Corresponds to the JSON property `startTime`
490
+ # @return [String]
491
+ attr_accessor :start_time
492
+
493
+ def initialize(**args)
494
+ update!(**args)
495
+ end
496
+
497
+ # Update properties of this object
498
+ def update!(**args)
499
+ @end_time = args[:end_time] if args.key?(:end_time)
500
+ @progress_percent = args[:progress_percent] if args.key?(:progress_percent)
501
+ @start_time = args[:start_time] if args.key?(:start_time)
502
+ end
503
+ end
504
+
505
+ # Metadata type for the long-running operation used to track the progress of
506
+ # optimizations performed on a newly restored table. This long-running operation
507
+ # is automatically created by the system after the successful completion of a
508
+ # table restore, and cannot be cancelled.
509
+ class OptimizeRestoredTableMetadata
510
+ include Google::Apis::Core::Hashable
511
+
512
+ # Name of the restored table being optimized.
513
+ # Corresponds to the JSON property `name`
514
+ # @return [String]
515
+ attr_accessor :name
516
+
517
+ # Encapsulates progress related information for a Cloud Bigtable long running
518
+ # operation.
519
+ # Corresponds to the JSON property `progress`
520
+ # @return [Google::Apis::BigtableadminV1::OperationProgress]
521
+ attr_accessor :progress
522
+
523
+ def initialize(**args)
524
+ update!(**args)
525
+ end
526
+
527
+ # Update properties of this object
528
+ def update!(**args)
529
+ @name = args[:name] if args.key?(:name)
530
+ @progress = args[:progress] if args.key?(:progress)
531
+ end
532
+ end
533
+
534
+ # Request message for BigtableInstanceAdmin.PartialUpdateInstance.
535
+ class PartialUpdateInstanceRequest
536
+ include Google::Apis::Core::Hashable
537
+
538
+ # A collection of Bigtable Tables and the resources that serve them. All tables
539
+ # in an instance are served from all Clusters in the instance.
540
+ # Corresponds to the JSON property `instance`
541
+ # @return [Google::Apis::BigtableadminV1::Instance]
542
+ attr_accessor :instance
543
+
544
+ # Required. The subset of Instance fields which should be replaced. Must be
545
+ # explicitly set.
546
+ # Corresponds to the JSON property `updateMask`
547
+ # @return [String]
548
+ attr_accessor :update_mask
549
+
550
+ def initialize(**args)
551
+ update!(**args)
552
+ end
553
+
554
+ # Update properties of this object
555
+ def update!(**args)
556
+ @instance = args[:instance] if args.key?(:instance)
557
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
558
+ end
559
+ end
560
+
561
+ # Metadata type for the long-running operation returned by RestoreTable.
562
+ class RestoreTableMetadata
563
+ include Google::Apis::Core::Hashable
564
+
565
+ # Information about a backup.
566
+ # Corresponds to the JSON property `backupInfo`
567
+ # @return [Google::Apis::BigtableadminV1::BackupInfo]
568
+ attr_accessor :backup_info
569
+
570
+ # Name of the table being created and restored to.
571
+ # Corresponds to the JSON property `name`
572
+ # @return [String]
573
+ attr_accessor :name
574
+
575
+ # If exists, the name of the long-running operation that will be used to track
576
+ # the post-restore optimization process to optimize the performance of the
577
+ # restored table. The metadata type of the long-running operation is
578
+ # OptimizeRestoreTableMetadata. The response type is Empty. This long-running
579
+ # operation may be automatically created by the system if applicable after the
580
+ # RestoreTable long-running operation completes successfully. This operation may
581
+ # not be created if the table is already optimized or the restore was not
582
+ # successful.
583
+ # Corresponds to the JSON property `optimizeTableOperationName`
584
+ # @return [String]
585
+ attr_accessor :optimize_table_operation_name
586
+
587
+ # Encapsulates progress related information for a Cloud Bigtable long running
588
+ # operation.
589
+ # Corresponds to the JSON property `progress`
590
+ # @return [Google::Apis::BigtableadminV1::OperationProgress]
591
+ attr_accessor :progress
592
+
593
+ # The type of the restore source.
594
+ # Corresponds to the JSON property `sourceType`
595
+ # @return [String]
596
+ attr_accessor :source_type
597
+
598
+ def initialize(**args)
599
+ update!(**args)
600
+ end
601
+
602
+ # Update properties of this object
603
+ def update!(**args)
604
+ @backup_info = args[:backup_info] if args.key?(:backup_info)
605
+ @name = args[:name] if args.key?(:name)
606
+ @optimize_table_operation_name = args[:optimize_table_operation_name] if args.key?(:optimize_table_operation_name)
607
+ @progress = args[:progress] if args.key?(:progress)
608
+ @source_type = args[:source_type] if args.key?(:source_type)
609
+ end
610
+ end
611
+
612
+ # Progress info for copying a table's data to the new cluster.
613
+ class TableProgress
614
+ include Google::Apis::Core::Hashable
615
+
616
+ # Estimate of the number of bytes copied so far for this table. This will
617
+ # eventually reach 'estimated_size_bytes' unless the table copy is CANCELLED.
618
+ # Corresponds to the JSON property `estimatedCopiedBytes`
619
+ # @return [Fixnum]
620
+ attr_accessor :estimated_copied_bytes
621
+
622
+ # Estimate of the size of the table to be copied.
623
+ # Corresponds to the JSON property `estimatedSizeBytes`
624
+ # @return [Fixnum]
625
+ attr_accessor :estimated_size_bytes
626
+
627
+ #
628
+ # Corresponds to the JSON property `state`
629
+ # @return [String]
630
+ attr_accessor :state
631
+
632
+ def initialize(**args)
633
+ update!(**args)
634
+ end
635
+
636
+ # Update properties of this object
637
+ def update!(**args)
638
+ @estimated_copied_bytes = args[:estimated_copied_bytes] if args.key?(:estimated_copied_bytes)
639
+ @estimated_size_bytes = args[:estimated_size_bytes] if args.key?(:estimated_size_bytes)
640
+ @state = args[:state] if args.key?(:state)
641
+ end
642
+ end
643
+
644
+ # The metadata for the Operation returned by UpdateAppProfile.
645
+ class UpdateAppProfileMetadata
646
+ include Google::Apis::Core::Hashable
647
+
648
+ def initialize(**args)
649
+ update!(**args)
650
+ end
651
+
652
+ # Update properties of this object
653
+ def update!(**args)
654
+ end
655
+ end
656
+
657
+ # The metadata for the Operation returned by UpdateCluster.
658
+ class UpdateClusterMetadata
659
+ include Google::Apis::Core::Hashable
660
+
661
+ # The time at which the operation failed or was completed successfully.
662
+ # Corresponds to the JSON property `finishTime`
663
+ # @return [String]
664
+ attr_accessor :finish_time
665
+
666
+ # A resizable group of nodes in a particular cloud location, capable of serving
667
+ # all Tables in the parent Instance.
668
+ # Corresponds to the JSON property `originalRequest`
669
+ # @return [Google::Apis::BigtableadminV1::Cluster]
670
+ attr_accessor :original_request
671
+
672
+ # The time at which the original request was received.
673
+ # Corresponds to the JSON property `requestTime`
674
+ # @return [String]
675
+ attr_accessor :request_time
676
+
677
+ def initialize(**args)
678
+ update!(**args)
679
+ end
680
+
681
+ # Update properties of this object
682
+ def update!(**args)
683
+ @finish_time = args[:finish_time] if args.key?(:finish_time)
684
+ @original_request = args[:original_request] if args.key?(:original_request)
685
+ @request_time = args[:request_time] if args.key?(:request_time)
686
+ end
687
+ end
688
+
689
+ # The metadata for the Operation returned by UpdateInstance.
690
+ class UpdateInstanceMetadata
691
+ include Google::Apis::Core::Hashable
692
+
693
+ # The time at which the operation failed or was completed successfully.
694
+ # Corresponds to the JSON property `finishTime`
695
+ # @return [String]
696
+ attr_accessor :finish_time
697
+
698
+ # Request message for BigtableInstanceAdmin.PartialUpdateInstance.
699
+ # Corresponds to the JSON property `originalRequest`
700
+ # @return [Google::Apis::BigtableadminV1::PartialUpdateInstanceRequest]
701
+ attr_accessor :original_request
702
+
703
+ # The time at which the original request was received.
704
+ # Corresponds to the JSON property `requestTime`
705
+ # @return [String]
706
+ attr_accessor :request_time
707
+
708
+ def initialize(**args)
709
+ update!(**args)
710
+ end
711
+
712
+ # Update properties of this object
713
+ def update!(**args)
714
+ @finish_time = args[:finish_time] if args.key?(:finish_time)
715
+ @original_request = args[:original_request] if args.key?(:original_request)
716
+ @request_time = args[:request_time] if args.key?(:request_time)
717
+ end
718
+ end
719
+ end
720
+ end
721
+ end