google-cloud-spanner-admin-instance-v1 0.1.4 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +5 -5
- data/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb +27 -39
- data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/operations.rb +95 -10
- data/lib/google/cloud/spanner/admin/instance/v1/version.rb +1 -1
- data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb +2 -0
- data/lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/longrunning/operations.rb +17 -3
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- data/proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb +10 -1
- metadata +23 -13
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ff511c61193142872dfe9e5b9cea6e14e636478d8714abb6f75c27b1c768f9b1
|
|
4
|
+
data.tar.gz: fc23262ae8898d00f13e691758de74489d9655fd9a02b18dbbc6bf139355af73
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f3fe19f5df47dfe55fc5e1b767246a310c14700c0e84c19f7dc29fcbc5861135ebec19f5e565e5fa70ccec6ecc2c684cde224abafcde6024449a862b1508fec6
|
|
7
|
+
data.tar.gz: e7202e2489b4ef98753e993682bad1d81e82a1f630fb4dd9ae07a7ddbee504647a11668d98d3b47bc0d09392d487b76d779ab6e4794c4754b1f0d63f2ca849ba
|
data/AUTHENTICATION.md
CHANGED
|
@@ -66,11 +66,11 @@ The environment variables that google-cloud-spanner-admin-instance-v1
|
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
|
67
67
|
{::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Credentials}):
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
* `SPANNER_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `SPANNER_KEYFILE` - Path to JSON file, or JSON contents
|
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
74
74
|
|
|
75
75
|
```ruby
|
|
76
76
|
require "google/cloud/spanner/admin/instance/v1"
|
data/LICENSE.md
CHANGED
|
@@ -1,192 +1,190 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
same "printed page" as the copyright notice for easier
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
190
188
|
|
|
191
189
|
Copyright [yyyy] [name of copyright owner]
|
|
192
190
|
|
|
@@ -194,7 +192,7 @@ identification within third-party archives.
|
|
|
194
192
|
you may not use this file except in compliance with the License.
|
|
195
193
|
You may obtain a copy of the License at
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
196
|
|
|
199
197
|
Unless required by applicable law or agreed to in writing, software
|
|
200
198
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/README.md
CHANGED
|
@@ -6,6 +6,12 @@ Cloud Spanner is a managed, mission-critical, globally consistent and scalable r
|
|
|
6
6
|
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
8
|
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
|
10
|
+
specific version of the Cloud Spanner Instance Admin V1 API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-cloud-spanner-admin-instance](https://rubygems.org/gems/google-cloud-spanner-admin-instance).
|
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
|
14
|
+
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
11
17
|
```
|
|
@@ -27,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
27
33
|
require "google/cloud/spanner/admin/instance/v1"
|
|
28
34
|
|
|
29
35
|
client = ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client.new
|
|
30
|
-
request =
|
|
36
|
+
request = ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest.new # (request fields as keyword arguments...)
|
|
31
37
|
response = client.list_instance_configs request
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -65,11 +71,69 @@ end
|
|
|
65
71
|
|
|
66
72
|
## Supported Ruby Versions
|
|
67
73
|
|
|
68
|
-
This library is supported on Ruby 2.
|
|
74
|
+
This library is supported on Ruby 2.5+.
|
|
69
75
|
|
|
70
76
|
Google provides official support for Ruby versions that are actively supported
|
|
71
77
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
72
|
-
in security maintenance, and not end of life. Currently, this means Ruby 2.
|
|
78
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.5
|
|
73
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
74
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
75
81
|
about the Ruby support schedule.
|
|
82
|
+
|
|
83
|
+
## Which client should I use?
|
|
84
|
+
|
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
86
|
+
client library with a name such as `google-cloud-spanner-admin-instance`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-spanner-admin-instance-v1`.
|
|
89
|
+
_In most cases, you should install the main client._
|
|
90
|
+
|
|
91
|
+
### What's the difference between the main client and a versioned client?
|
|
92
|
+
|
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
|
97
|
+
|
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
|
100
|
+
service, even a service with multiple versions. The main client includes
|
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
105
|
+
Generally, the main client will default to a recommended service version,
|
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
|
107
|
+
service version.
|
|
108
|
+
|
|
109
|
+
### Why would I want to use the main client?
|
|
110
|
+
|
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
113
|
+
`google-cloud-spanner-admin-instance`.
|
|
114
|
+
The main client is recommended because it will embody the best practices for
|
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
118
|
+
the main client.
|
|
119
|
+
|
|
120
|
+
### Why would I want to use a versioned client?
|
|
121
|
+
|
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
|
125
|
+
main client. You can identify versioned client gems because the service version
|
|
126
|
+
is part of the name, e.g. `google-cloud-spanner-admin-instance-v1`.
|
|
127
|
+
|
|
128
|
+
### What about the google-apis-<name> clients?
|
|
129
|
+
|
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
|
134
|
+
modern clients.
|
|
135
|
+
|
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
137
|
+
might need to use one if there is no modern client available for the service.
|
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
|
139
|
+
older `google-apis-` clients.
|
|
@@ -82,41 +82,29 @@ module Google
|
|
|
82
82
|
parent_config = while namespace.any?
|
|
83
83
|
parent_name = namespace.join "::"
|
|
84
84
|
parent_const = const_get parent_name
|
|
85
|
-
break parent_const.configure if parent_const
|
|
85
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
86
86
|
namespace.pop
|
|
87
87
|
end
|
|
88
88
|
default_config = Client::Configuration.new parent_config
|
|
89
89
|
|
|
90
90
|
default_config.rpcs.list_instance_configs.timeout = 3600.0
|
|
91
91
|
default_config.rpcs.list_instance_configs.retry_policy = {
|
|
92
|
-
initial_delay: 1.0,
|
|
93
|
-
max_delay: 32.0,
|
|
94
|
-
multiplier: 1.3,
|
|
95
|
-
retry_codes: [14, 4]
|
|
92
|
+
initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
96
93
|
}
|
|
97
94
|
|
|
98
95
|
default_config.rpcs.get_instance_config.timeout = 3600.0
|
|
99
96
|
default_config.rpcs.get_instance_config.retry_policy = {
|
|
100
|
-
initial_delay: 1.0,
|
|
101
|
-
max_delay: 32.0,
|
|
102
|
-
multiplier: 1.3,
|
|
103
|
-
retry_codes: [14, 4]
|
|
97
|
+
initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
104
98
|
}
|
|
105
99
|
|
|
106
100
|
default_config.rpcs.list_instances.timeout = 3600.0
|
|
107
101
|
default_config.rpcs.list_instances.retry_policy = {
|
|
108
|
-
initial_delay: 1.0,
|
|
109
|
-
max_delay: 32.0,
|
|
110
|
-
multiplier: 1.3,
|
|
111
|
-
retry_codes: [14, 4]
|
|
102
|
+
initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
112
103
|
}
|
|
113
104
|
|
|
114
105
|
default_config.rpcs.get_instance.timeout = 3600.0
|
|
115
106
|
default_config.rpcs.get_instance.retry_policy = {
|
|
116
|
-
initial_delay: 1.0,
|
|
117
|
-
max_delay: 32.0,
|
|
118
|
-
multiplier: 1.3,
|
|
119
|
-
retry_codes: [14, 4]
|
|
107
|
+
initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
120
108
|
}
|
|
121
109
|
|
|
122
110
|
default_config.rpcs.create_instance.timeout = 3600.0
|
|
@@ -125,20 +113,14 @@ module Google
|
|
|
125
113
|
|
|
126
114
|
default_config.rpcs.delete_instance.timeout = 3600.0
|
|
127
115
|
default_config.rpcs.delete_instance.retry_policy = {
|
|
128
|
-
initial_delay: 1.0,
|
|
129
|
-
max_delay: 32.0,
|
|
130
|
-
multiplier: 1.3,
|
|
131
|
-
retry_codes: [14, 4]
|
|
116
|
+
initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
132
117
|
}
|
|
133
118
|
|
|
134
119
|
default_config.rpcs.set_iam_policy.timeout = 30.0
|
|
135
120
|
|
|
136
121
|
default_config.rpcs.get_iam_policy.timeout = 30.0
|
|
137
122
|
default_config.rpcs.get_iam_policy.retry_policy = {
|
|
138
|
-
initial_delay: 1.0,
|
|
139
|
-
max_delay: 32.0,
|
|
140
|
-
multiplier: 1.3,
|
|
141
|
-
retry_codes: [14, 4]
|
|
123
|
+
initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
142
124
|
}
|
|
143
125
|
|
|
144
126
|
default_config.rpcs.test_iam_permissions.timeout = 30.0
|
|
@@ -204,8 +186,14 @@ module Google
|
|
|
204
186
|
|
|
205
187
|
# Create credentials
|
|
206
188
|
credentials = @config.credentials
|
|
207
|
-
|
|
208
|
-
if
|
|
189
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
190
|
+
# but only if the default endpoint does not have a region prefix.
|
|
191
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
192
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
193
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
194
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
195
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
196
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
209
197
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
210
198
|
end
|
|
211
199
|
@quota_project_id = @config.quota_project
|
|
@@ -1159,7 +1147,7 @@ module Google
|
|
|
1159
1147
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
1160
1148
|
config_attr :lib_name, nil, ::String, nil
|
|
1161
1149
|
config_attr :lib_version, nil, ::String, nil
|
|
1162
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
1150
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
1163
1151
|
config_attr :interceptors, nil, ::Array, nil
|
|
1164
1152
|
config_attr :timeout, nil, ::Numeric, nil
|
|
1165
1153
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -1180,7 +1168,7 @@ module Google
|
|
|
1180
1168
|
def rpcs
|
|
1181
1169
|
@rpcs ||= begin
|
|
1182
1170
|
parent_rpcs = nil
|
|
1183
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
1171
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
1184
1172
|
Rpcs.new parent_rpcs
|
|
1185
1173
|
end
|
|
1186
1174
|
end
|
|
@@ -1256,25 +1244,25 @@ module Google
|
|
|
1256
1244
|
|
|
1257
1245
|
# @private
|
|
1258
1246
|
def initialize parent_rpcs = nil
|
|
1259
|
-
list_instance_configs_config = parent_rpcs
|
|
1247
|
+
list_instance_configs_config = parent_rpcs.list_instance_configs if parent_rpcs.respond_to? :list_instance_configs
|
|
1260
1248
|
@list_instance_configs = ::Gapic::Config::Method.new list_instance_configs_config
|
|
1261
|
-
get_instance_config_config = parent_rpcs
|
|
1249
|
+
get_instance_config_config = parent_rpcs.get_instance_config if parent_rpcs.respond_to? :get_instance_config
|
|
1262
1250
|
@get_instance_config = ::Gapic::Config::Method.new get_instance_config_config
|
|
1263
|
-
list_instances_config = parent_rpcs
|
|
1251
|
+
list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
|
|
1264
1252
|
@list_instances = ::Gapic::Config::Method.new list_instances_config
|
|
1265
|
-
get_instance_config = parent_rpcs
|
|
1253
|
+
get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
|
|
1266
1254
|
@get_instance = ::Gapic::Config::Method.new get_instance_config
|
|
1267
|
-
create_instance_config = parent_rpcs
|
|
1255
|
+
create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
|
|
1268
1256
|
@create_instance = ::Gapic::Config::Method.new create_instance_config
|
|
1269
|
-
update_instance_config = parent_rpcs
|
|
1257
|
+
update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
|
|
1270
1258
|
@update_instance = ::Gapic::Config::Method.new update_instance_config
|
|
1271
|
-
delete_instance_config = parent_rpcs
|
|
1259
|
+
delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
|
|
1272
1260
|
@delete_instance = ::Gapic::Config::Method.new delete_instance_config
|
|
1273
|
-
set_iam_policy_config = parent_rpcs
|
|
1261
|
+
set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
|
|
1274
1262
|
@set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
|
|
1275
|
-
get_iam_policy_config = parent_rpcs
|
|
1263
|
+
get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
|
|
1276
1264
|
@get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
|
|
1277
|
-
test_iam_permissions_config = parent_rpcs
|
|
1265
|
+
test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
|
|
1278
1266
|
@test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
|
|
1279
1267
|
|
|
1280
1268
|
yield self if block_given?
|
|
@@ -84,7 +84,7 @@ module Google
|
|
|
84
84
|
# Create credentials
|
|
85
85
|
credentials = @config.credentials
|
|
86
86
|
credentials ||= Credentials.default scope: @config.scope
|
|
87
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
|
87
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
88
88
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
89
89
|
end
|
|
90
90
|
@quota_project_id = @config.quota_project
|
|
@@ -105,8 +105,13 @@ module Google
|
|
|
105
105
|
# Lists operations that match the specified filter in the request. If the
|
|
106
106
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
107
107
|
#
|
|
108
|
-
# NOTE: the `name` binding
|
|
109
|
-
# to use different resource name schemes, such as `users/*/operations`.
|
|
108
|
+
# NOTE: the `name` binding allows API services to override the binding
|
|
109
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
|
110
|
+
# override the binding, API services can add a binding such as
|
|
111
|
+
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
|
112
|
+
# For backwards compatibility, the default name includes the operations
|
|
113
|
+
# collection id, however overriding users must ensure the name binding
|
|
114
|
+
# is the parent resource, without the operations collection id.
|
|
110
115
|
#
|
|
111
116
|
# @overload list_operations(request, options = nil)
|
|
112
117
|
# Pass arguments to `list_operations` via a request object, either of type
|
|
@@ -124,7 +129,7 @@ module Google
|
|
|
124
129
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
125
130
|
#
|
|
126
131
|
# @param name [::String]
|
|
127
|
-
# The name of the operation
|
|
132
|
+
# The name of the operation's parent resource.
|
|
128
133
|
# @param filter [::String]
|
|
129
134
|
# The standard list filter.
|
|
130
135
|
# @param page_size [::Integer]
|
|
@@ -392,6 +397,79 @@ module Google
|
|
|
392
397
|
raise ::Google::Cloud::Error.from_error(e)
|
|
393
398
|
end
|
|
394
399
|
|
|
400
|
+
##
|
|
401
|
+
# Waits for the specified long-running operation until it is done or reaches
|
|
402
|
+
# at most a specified timeout, returning the latest state. If the operation
|
|
403
|
+
# is already done, the latest state is immediately returned. If the timeout
|
|
404
|
+
# specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
|
|
405
|
+
# timeout is used. If the server does not support this method, it returns
|
|
406
|
+
# `google.rpc.Code.UNIMPLEMENTED`.
|
|
407
|
+
# Note that this method is on a best-effort basis. It may return the latest
|
|
408
|
+
# state before the specified timeout (including immediately), meaning even an
|
|
409
|
+
# immediate response is no guarantee that the operation is done.
|
|
410
|
+
#
|
|
411
|
+
# @overload wait_operation(request, options = nil)
|
|
412
|
+
# Pass arguments to `wait_operation` via a request object, either of type
|
|
413
|
+
# {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
|
|
414
|
+
#
|
|
415
|
+
# @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
|
|
416
|
+
# A request object representing the call parameters. Required. To specify no
|
|
417
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
418
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
419
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
420
|
+
#
|
|
421
|
+
# @overload wait_operation(name: nil, timeout: nil)
|
|
422
|
+
# Pass arguments to `wait_operation` via keyword arguments. Note that at
|
|
423
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
424
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
425
|
+
#
|
|
426
|
+
# @param name [::String]
|
|
427
|
+
# The name of the operation resource to wait on.
|
|
428
|
+
# @param timeout [::Google::Protobuf::Duration, ::Hash]
|
|
429
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
430
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
431
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
432
|
+
#
|
|
433
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
434
|
+
# @yieldparam response [::Gapic::Operation]
|
|
435
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
436
|
+
#
|
|
437
|
+
# @return [::Gapic::Operation]
|
|
438
|
+
#
|
|
439
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
440
|
+
#
|
|
441
|
+
def wait_operation request, options = nil
|
|
442
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
443
|
+
|
|
444
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
|
|
445
|
+
|
|
446
|
+
# Converts hash and nil to an options object
|
|
447
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
448
|
+
|
|
449
|
+
# Customize the options with defaults
|
|
450
|
+
metadata = @config.rpcs.wait_operation.metadata.to_h
|
|
451
|
+
|
|
452
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
453
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
454
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
455
|
+
gapic_version: ::Google::Cloud::Spanner::Admin::Instance::V1::VERSION
|
|
456
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
457
|
+
|
|
458
|
+
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
|
459
|
+
metadata: metadata,
|
|
460
|
+
retry_policy: @config.rpcs.wait_operation.retry_policy
|
|
461
|
+
options.apply_defaults metadata: @config.metadata,
|
|
462
|
+
retry_policy: @config.retry_policy
|
|
463
|
+
|
|
464
|
+
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
|
465
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
|
466
|
+
yield response, operation if block_given?
|
|
467
|
+
return response
|
|
468
|
+
end
|
|
469
|
+
rescue ::GRPC::BadStatus => e
|
|
470
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
471
|
+
end
|
|
472
|
+
|
|
395
473
|
##
|
|
396
474
|
# Configuration class for the Operations API.
|
|
397
475
|
#
|
|
@@ -484,7 +562,7 @@ module Google
|
|
|
484
562
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
485
563
|
config_attr :lib_name, nil, ::String, nil
|
|
486
564
|
config_attr :lib_version, nil, ::String, nil
|
|
487
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
565
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
488
566
|
config_attr :interceptors, nil, ::Array, nil
|
|
489
567
|
config_attr :timeout, nil, ::Numeric, nil
|
|
490
568
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -505,7 +583,7 @@ module Google
|
|
|
505
583
|
def rpcs
|
|
506
584
|
@rpcs ||= begin
|
|
507
585
|
parent_rpcs = nil
|
|
508
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
586
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
509
587
|
Rpcs.new parent_rpcs
|
|
510
588
|
end
|
|
511
589
|
end
|
|
@@ -548,17 +626,24 @@ module Google
|
|
|
548
626
|
# @return [::Gapic::Config::Method]
|
|
549
627
|
#
|
|
550
628
|
attr_reader :cancel_operation
|
|
629
|
+
##
|
|
630
|
+
# RPC-specific configuration for `wait_operation`
|
|
631
|
+
# @return [::Gapic::Config::Method]
|
|
632
|
+
#
|
|
633
|
+
attr_reader :wait_operation
|
|
551
634
|
|
|
552
635
|
# @private
|
|
553
636
|
def initialize parent_rpcs = nil
|
|
554
|
-
list_operations_config = parent_rpcs
|
|
637
|
+
list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
|
|
555
638
|
@list_operations = ::Gapic::Config::Method.new list_operations_config
|
|
556
|
-
get_operation_config = parent_rpcs
|
|
639
|
+
get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
|
|
557
640
|
@get_operation = ::Gapic::Config::Method.new get_operation_config
|
|
558
|
-
delete_operation_config = parent_rpcs
|
|
641
|
+
delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
|
|
559
642
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
|
560
|
-
cancel_operation_config = parent_rpcs
|
|
643
|
+
cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
|
|
561
644
|
@cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
|
|
645
|
+
wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
|
|
646
|
+
@wait_operation = ::Gapic::Config::Method.new wait_operation_config
|
|
562
647
|
|
|
563
648
|
yield self if block_given?
|
|
564
649
|
end
|
|
@@ -30,12 +30,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
30
30
|
optional :name, :string, 1
|
|
31
31
|
optional :display_name, :string, 2
|
|
32
32
|
repeated :replicas, :message, 3, "google.spanner.admin.instance.v1.ReplicaInfo"
|
|
33
|
+
repeated :leader_options, :string, 4
|
|
33
34
|
end
|
|
34
35
|
add_message "google.spanner.admin.instance.v1.Instance" do
|
|
35
36
|
optional :name, :string, 1
|
|
36
37
|
optional :config, :string, 2
|
|
37
38
|
optional :display_name, :string, 3
|
|
38
39
|
optional :node_count, :int32, 5
|
|
40
|
+
optional :processing_units, :int32, 9
|
|
39
41
|
optional :state, :enum, 6, "google.spanner.admin.instance.v1.Instance.State"
|
|
40
42
|
map :labels, :string, :string, 7
|
|
41
43
|
repeated :endpoint_uris, :string, 8
|
|
@@ -54,6 +54,12 @@ module Google
|
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
|
55
55
|
# resource, but may not be changed thereafter.
|
|
56
56
|
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
59
|
+
# This indicates that the service may provide the elements of the list
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
62
|
+
UNORDERED_LIST = 6
|
|
57
63
|
end
|
|
58
64
|
end
|
|
59
65
|
end
|
|
@@ -25,7 +25,7 @@ module Google
|
|
|
25
25
|
# @return [::String]
|
|
26
26
|
# The server-assigned name, which is only unique within the same service that
|
|
27
27
|
# originally returns it. If you use the default HTTP mapping, the
|
|
28
|
-
# `name` should
|
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
|
29
29
|
# @!attribute [rw] metadata
|
|
30
30
|
# @return [::Google::Protobuf::Any]
|
|
31
31
|
# Service-specific metadata associated with the operation. It typically
|
|
@@ -35,7 +35,7 @@ module Google
|
|
|
35
35
|
# @!attribute [rw] done
|
|
36
36
|
# @return [::Boolean]
|
|
37
37
|
# If the value is `false`, it means the operation is still in progress.
|
|
38
|
-
# If true
|
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
|
39
39
|
# available.
|
|
40
40
|
# @!attribute [rw] error
|
|
41
41
|
# @return [::Google::Rpc::Status]
|
|
@@ -67,7 +67,7 @@ module Google
|
|
|
67
67
|
# The request message for Operations.ListOperations.
|
|
68
68
|
# @!attribute [rw] name
|
|
69
69
|
# @return [::String]
|
|
70
|
-
# The name of the operation
|
|
70
|
+
# The name of the operation's parent resource.
|
|
71
71
|
# @!attribute [rw] filter
|
|
72
72
|
# @return [::String]
|
|
73
73
|
# The standard list filter.
|
|
@@ -112,6 +112,20 @@ module Google
|
|
|
112
112
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
113
113
|
end
|
|
114
114
|
|
|
115
|
+
# The request message for Operations.WaitOperation.
|
|
116
|
+
# @!attribute [rw] name
|
|
117
|
+
# @return [::String]
|
|
118
|
+
# The name of the operation resource to wait on.
|
|
119
|
+
# @!attribute [rw] timeout
|
|
120
|
+
# @return [::Google::Protobuf::Duration]
|
|
121
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
122
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
123
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
124
|
+
class WaitOperationRequest
|
|
125
|
+
include ::Google::Protobuf::MessageExts
|
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
127
|
+
end
|
|
128
|
+
|
|
115
129
|
# A message representing the message types used by a long-running operation.
|
|
116
130
|
#
|
|
117
131
|
# Example:
|
|
@@ -57,10 +57,13 @@ module Google
|
|
|
57
57
|
# Example 4: Pack and unpack a message in Go
|
|
58
58
|
#
|
|
59
59
|
# foo := &pb.Foo{...}
|
|
60
|
-
# any, err :=
|
|
60
|
+
# any, err := anypb.New(foo)
|
|
61
|
+
# if err != nil {
|
|
62
|
+
# ...
|
|
63
|
+
# }
|
|
61
64
|
# ...
|
|
62
65
|
# foo := &pb.Foo{}
|
|
63
|
-
# if err :=
|
|
66
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
|
64
67
|
# ...
|
|
65
68
|
# }
|
|
66
69
|
#
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2021 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Protobuf
|
|
22
|
+
# A Duration represents a signed, fixed-length span of time represented
|
|
23
|
+
# as a count of seconds and fractions of seconds at nanosecond
|
|
24
|
+
# resolution. It is independent of any calendar and concepts like "day"
|
|
25
|
+
# or "month". It is related to Timestamp in that the difference between
|
|
26
|
+
# two Timestamp values is a Duration and it can be added or subtracted
|
|
27
|
+
# from a Timestamp. Range is approximately +-10,000 years.
|
|
28
|
+
#
|
|
29
|
+
# # Examples
|
|
30
|
+
#
|
|
31
|
+
# Example 1: Compute Duration from two Timestamps in pseudo code.
|
|
32
|
+
#
|
|
33
|
+
# Timestamp start = ...;
|
|
34
|
+
# Timestamp end = ...;
|
|
35
|
+
# Duration duration = ...;
|
|
36
|
+
#
|
|
37
|
+
# duration.seconds = end.seconds - start.seconds;
|
|
38
|
+
# duration.nanos = end.nanos - start.nanos;
|
|
39
|
+
#
|
|
40
|
+
# if (duration.seconds < 0 && duration.nanos > 0) {
|
|
41
|
+
# duration.seconds += 1;
|
|
42
|
+
# duration.nanos -= 1000000000;
|
|
43
|
+
# } else if (duration.seconds > 0 && duration.nanos < 0) {
|
|
44
|
+
# duration.seconds -= 1;
|
|
45
|
+
# duration.nanos += 1000000000;
|
|
46
|
+
# }
|
|
47
|
+
#
|
|
48
|
+
# Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
|
49
|
+
#
|
|
50
|
+
# Timestamp start = ...;
|
|
51
|
+
# Duration duration = ...;
|
|
52
|
+
# Timestamp end = ...;
|
|
53
|
+
#
|
|
54
|
+
# end.seconds = start.seconds + duration.seconds;
|
|
55
|
+
# end.nanos = start.nanos + duration.nanos;
|
|
56
|
+
#
|
|
57
|
+
# if (end.nanos < 0) {
|
|
58
|
+
# end.seconds -= 1;
|
|
59
|
+
# end.nanos += 1000000000;
|
|
60
|
+
# } else if (end.nanos >= 1000000000) {
|
|
61
|
+
# end.seconds += 1;
|
|
62
|
+
# end.nanos -= 1000000000;
|
|
63
|
+
# }
|
|
64
|
+
#
|
|
65
|
+
# Example 3: Compute Duration from datetime.timedelta in Python.
|
|
66
|
+
#
|
|
67
|
+
# td = datetime.timedelta(days=3, minutes=10)
|
|
68
|
+
# duration = Duration()
|
|
69
|
+
# duration.FromTimedelta(td)
|
|
70
|
+
#
|
|
71
|
+
# # JSON Mapping
|
|
72
|
+
#
|
|
73
|
+
# In JSON format, the Duration type is encoded as a string rather than an
|
|
74
|
+
# object, where the string ends in the suffix "s" (indicating seconds) and
|
|
75
|
+
# is preceded by the number of seconds, with nanoseconds expressed as
|
|
76
|
+
# fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
|
77
|
+
# encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
|
78
|
+
# be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
|
79
|
+
# microsecond should be expressed in JSON format as "3.000001s".
|
|
80
|
+
# @!attribute [rw] seconds
|
|
81
|
+
# @return [::Integer]
|
|
82
|
+
# Signed seconds of the span of time. Must be from -315,576,000,000
|
|
83
|
+
# to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
|
84
|
+
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
|
85
|
+
# @!attribute [rw] nanos
|
|
86
|
+
# @return [::Integer]
|
|
87
|
+
# Signed fractions of a second at nanosecond resolution of the span
|
|
88
|
+
# of time. Durations less than one second are represented with a 0
|
|
89
|
+
# `seconds` field and a positive or negative `nanos` field. For durations
|
|
90
|
+
# of one second or more, a non-zero value for the `nanos` field must be
|
|
91
|
+
# of the same sign as the `seconds` field. Must be from -999,999,999
|
|
92
|
+
# to +999,999,999 inclusive.
|
|
93
|
+
class Duration
|
|
94
|
+
include ::Google::Protobuf::MessageExts
|
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
@@ -70,7 +70,16 @@ module Google
|
|
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
|
71
71
|
#
|
|
72
72
|
#
|
|
73
|
-
# Example 5: Compute Timestamp from
|
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
|
74
|
+
#
|
|
75
|
+
# Instant now = Instant.now();
|
|
76
|
+
#
|
|
77
|
+
# Timestamp timestamp =
|
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
|
79
|
+
# .setNanos(now.getNano()).build();
|
|
80
|
+
#
|
|
81
|
+
#
|
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
|
74
83
|
#
|
|
75
84
|
# timestamp = Timestamp()
|
|
76
85
|
# timestamp.GetCurrentTime()
|
|
@@ -88,6 +88,10 @@ module Google
|
|
|
88
88
|
# @return [::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>]
|
|
89
89
|
# The geographic placement of nodes in this instance configuration and their
|
|
90
90
|
# replication properties.
|
|
91
|
+
# @!attribute [rw] leader_options
|
|
92
|
+
# @return [::Array<::String>]
|
|
93
|
+
# Allowed values of the “default_leader” schema option for databases in
|
|
94
|
+
# instances that use this instance configuration.
|
|
91
95
|
class InstanceConfig
|
|
92
96
|
include ::Google::Protobuf::MessageExts
|
|
93
97
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -118,7 +122,12 @@ module Google
|
|
|
118
122
|
# See [the
|
|
119
123
|
# documentation](https://cloud.google.com/spanner/docs/instances#node_count)
|
|
120
124
|
# for more information about nodes.
|
|
121
|
-
# @!attribute [rw]
|
|
125
|
+
# @!attribute [rw] processing_units
|
|
126
|
+
# @return [::Integer]
|
|
127
|
+
# The number of processing units allocated to this instance. At most one of
|
|
128
|
+
# processing_units or node_count should be present in the message. This may
|
|
129
|
+
# be zero in API responses for instances that are not yet in state `READY`.
|
|
130
|
+
# @!attribute [r] state
|
|
122
131
|
# @return [::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State]
|
|
123
132
|
# Output only. The current instance state. For
|
|
124
133
|
# {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client#create_instance CreateInstance}, the state must be
|
metadata
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-spanner-admin-instance-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.5.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-07-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- - "
|
|
17
|
+
- - ">="
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.5'
|
|
20
|
+
- - "<"
|
|
18
21
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
22
|
+
version: 2.a
|
|
20
23
|
type: :runtime
|
|
21
24
|
prerelease: false
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
26
|
requirements:
|
|
24
|
-
- - "
|
|
27
|
+
- - ">="
|
|
28
|
+
- !ruby/object:Gem::Version
|
|
29
|
+
version: '0.5'
|
|
30
|
+
- - "<"
|
|
25
31
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
32
|
+
version: 2.a
|
|
27
33
|
- !ruby/object:Gem::Dependency
|
|
28
34
|
name: google-cloud-errors
|
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -47,7 +53,7 @@ dependencies:
|
|
|
47
53
|
version: 0.6.10
|
|
48
54
|
- - "<"
|
|
49
55
|
- !ruby/object:Gem::Version
|
|
50
|
-
version:
|
|
56
|
+
version: 2.a
|
|
51
57
|
type: :runtime
|
|
52
58
|
prerelease: false
|
|
53
59
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -57,21 +63,21 @@ dependencies:
|
|
|
57
63
|
version: 0.6.10
|
|
58
64
|
- - "<"
|
|
59
65
|
- !ruby/object:Gem::Version
|
|
60
|
-
version:
|
|
66
|
+
version: 2.a
|
|
61
67
|
- !ruby/object:Gem::Dependency
|
|
62
68
|
name: google-style
|
|
63
69
|
requirement: !ruby/object:Gem::Requirement
|
|
64
70
|
requirements:
|
|
65
71
|
- - "~>"
|
|
66
72
|
- !ruby/object:Gem::Version
|
|
67
|
-
version: 1.
|
|
73
|
+
version: 1.25.1
|
|
68
74
|
type: :development
|
|
69
75
|
prerelease: false
|
|
70
76
|
version_requirements: !ruby/object:Gem::Requirement
|
|
71
77
|
requirements:
|
|
72
78
|
- - "~>"
|
|
73
79
|
- !ruby/object:Gem::Version
|
|
74
|
-
version: 1.
|
|
80
|
+
version: 1.25.1
|
|
75
81
|
- !ruby/object:Gem::Dependency
|
|
76
82
|
name: minitest
|
|
77
83
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -171,7 +177,10 @@ dependencies:
|
|
|
171
177
|
- !ruby/object:Gem::Version
|
|
172
178
|
version: '0.9'
|
|
173
179
|
description: Cloud Spanner is a managed, mission-critical, globally consistent and
|
|
174
|
-
scalable relational database service.
|
|
180
|
+
scalable relational database service. Note that google-cloud-spanner-admin-instance-v1
|
|
181
|
+
is a version-specific client library. For most uses, we recommend installing the
|
|
182
|
+
main client library google-cloud-spanner-admin-instance instead. See the readme
|
|
183
|
+
for more details.
|
|
175
184
|
email: googleapis-packages@google.com
|
|
176
185
|
executables: []
|
|
177
186
|
extensions: []
|
|
@@ -199,6 +208,7 @@ files:
|
|
|
199
208
|
- proto_docs/google/iam/v1/policy.rb
|
|
200
209
|
- proto_docs/google/longrunning/operations.rb
|
|
201
210
|
- proto_docs/google/protobuf/any.rb
|
|
211
|
+
- proto_docs/google/protobuf/duration.rb
|
|
202
212
|
- proto_docs/google/protobuf/empty.rb
|
|
203
213
|
- proto_docs/google/protobuf/field_mask.rb
|
|
204
214
|
- proto_docs/google/protobuf/timestamp.rb
|
|
@@ -217,14 +227,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
217
227
|
requirements:
|
|
218
228
|
- - ">="
|
|
219
229
|
- !ruby/object:Gem::Version
|
|
220
|
-
version: '2.
|
|
230
|
+
version: '2.5'
|
|
221
231
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
222
232
|
requirements:
|
|
223
233
|
- - ">="
|
|
224
234
|
- !ruby/object:Gem::Version
|
|
225
235
|
version: '0'
|
|
226
236
|
requirements: []
|
|
227
|
-
rubygems_version: 3.2.
|
|
237
|
+
rubygems_version: 3.2.17
|
|
228
238
|
signing_key:
|
|
229
239
|
specification_version: 4
|
|
230
240
|
summary: API Client library for the Cloud Spanner Instance Admin V1 API
|