google-cloud-spanner-admin-database-v1 0.3.0 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +188 -190
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb +73 -37
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/paths.rb +44 -0
- data/lib/google/cloud/spanner/admin/database/v1/version.rb +1 -1
- data/lib/google/spanner/admin/database/v1/backup_pb.rb +14 -1
- data/lib/google/spanner/admin/database/v1/common_pb.rb +18 -1
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb +16 -0
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +16 -12
- data/proto_docs/google/spanner/admin/database/v1/backup.rb +107 -38
- data/proto_docs/google/spanner/admin/database/v1/common.rb +45 -0
- data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb +113 -31
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 269acec86ce5504e501cae6dc22e2be973844331a253c239a0aa70ca7ab9d4eb
|
|
4
|
+
data.tar.gz: 0d8f5904dda393fa07a7bbf1384d95915440ec0a9db61dd612908bfad3180143
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 420a752f67672d10716d19c95e686d286e38d151ca173ce089cd638f5c6e28f2a73aaeba98b85215cb046364b6b10d02961ff5a8ddac996ed7a863ebf6777ab3
|
|
7
|
+
data.tar.gz: 33fd054761dec1ab7d4accbd9dc0f19c27ec915921f349e60a752a40c734742a8f6b9a3901545bf30bafb220261c654e69fa169d29ce8e1e2e198fedee44c79f
|
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,
|
|
@@ -301,8 +301,9 @@ module Google
|
|
|
301
301
|
# defaults to the server's maximum allowed page size.
|
|
302
302
|
# @param page_token [::String]
|
|
303
303
|
# If non-empty, `page_token` should contain a
|
|
304
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
|
|
305
|
-
#
|
|
304
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
|
|
305
|
+
# from a previous
|
|
306
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
|
|
306
307
|
#
|
|
307
308
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
308
309
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Spanner::Admin::Database::V1::Database>]
|
|
@@ -356,8 +357,8 @@ module Google
|
|
|
356
357
|
# have a name of the format `<database_name>/operations/<operation_id>` and
|
|
357
358
|
# can be used to track preparation of the database. The
|
|
358
359
|
# {::Google::Longrunning::Operation#metadata metadata} field type is
|
|
359
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}.
|
|
360
|
-
# {::Google::Longrunning::Operation#response response} field type is
|
|
360
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}.
|
|
361
|
+
# The {::Google::Longrunning::Operation#response response} field type is
|
|
361
362
|
# {::Google::Cloud::Spanner::Admin::Database::V1::Database Database}, if successful.
|
|
362
363
|
#
|
|
363
364
|
# @overload create_database(request, options = nil)
|
|
@@ -370,7 +371,7 @@ module Google
|
|
|
370
371
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
371
372
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
372
373
|
#
|
|
373
|
-
# @overload create_database(parent: nil, create_statement: nil, extra_statements: nil)
|
|
374
|
+
# @overload create_database(parent: nil, create_statement: nil, extra_statements: nil, encryption_config: nil)
|
|
374
375
|
# Pass arguments to `create_database` via keyword arguments. Note that at
|
|
375
376
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
376
377
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -389,6 +390,10 @@ module Google
|
|
|
389
390
|
# database. Statements can create tables, indexes, etc. These
|
|
390
391
|
# statements execute atomically with the creation of the database:
|
|
391
392
|
# if there is an error in any statement, the database is not created.
|
|
393
|
+
# @param encryption_config [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig, ::Hash]
|
|
394
|
+
# Optional. The encryption configuration for the database. If this field is
|
|
395
|
+
# not specified, Cloud Spanner will encrypt/decrypt all data at rest using
|
|
396
|
+
# Google default encryption.
|
|
392
397
|
#
|
|
393
398
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
394
399
|
# @yieldparam response [::Gapic::Operation]
|
|
@@ -510,7 +515,8 @@ module Google
|
|
|
510
515
|
# the format `<database_name>/operations/<operation_id>` and can be used to
|
|
511
516
|
# track execution of the schema change(s). The
|
|
512
517
|
# {::Google::Longrunning::Operation#metadata metadata} field type is
|
|
513
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}.
|
|
518
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}.
|
|
519
|
+
# The operation has no response.
|
|
514
520
|
#
|
|
515
521
|
# @overload update_database_ddl(request, options = nil)
|
|
516
522
|
# Pass arguments to `update_database_ddl` via a request object, either of type
|
|
@@ -539,18 +545,20 @@ module Google
|
|
|
539
545
|
#
|
|
540
546
|
# Specifying an explicit operation ID simplifies determining
|
|
541
547
|
# whether the statements were executed in the event that the
|
|
542
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
|
|
543
|
-
# or the return value is otherwise lost: the
|
|
544
|
-
#
|
|
548
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
|
|
549
|
+
# call is replayed, or the return value is otherwise lost: the
|
|
550
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
|
|
551
|
+
# and `operation_id` fields can be combined to form the
|
|
545
552
|
# {::Google::Longrunning::Operation#name name} of the resulting
|
|
546
|
-
# {::Google::Longrunning::Operation longrunning.Operation}:
|
|
553
|
+
# {::Google::Longrunning::Operation longrunning.Operation}:
|
|
554
|
+
# `<database>/operations/<operation_id>`.
|
|
547
555
|
#
|
|
548
556
|
# `operation_id` should be unique within the database, and must be
|
|
549
557
|
# a valid identifier: `[a-z][a-z0-9_]*`. Note that
|
|
550
558
|
# automatically-generated operation IDs always begin with an
|
|
551
559
|
# underscore. If the named operation already exists,
|
|
552
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
|
|
553
|
-
# `ALREADY_EXISTS`.
|
|
560
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
|
|
561
|
+
# returns `ALREADY_EXISTS`.
|
|
554
562
|
#
|
|
555
563
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
556
564
|
# @yieldparam response [::Gapic::Operation]
|
|
@@ -979,12 +987,12 @@ module Google
|
|
|
979
987
|
# `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
|
|
980
988
|
# and can be used to track creation of the backup. The
|
|
981
989
|
# {::Google::Longrunning::Operation#metadata metadata} field type is
|
|
982
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
|
|
983
|
-
# {::Google::Longrunning::Operation#response response} field type is
|
|
984
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}, if successful.
|
|
985
|
-
# creation and delete the
|
|
986
|
-
# There can be only one pending backup creation per database. Backup
|
|
987
|
-
# of different databases can run concurrently.
|
|
990
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
|
|
991
|
+
# The {::Google::Longrunning::Operation#response response} field type is
|
|
992
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}, if successful.
|
|
993
|
+
# Cancelling the returned operation will stop the creation and delete the
|
|
994
|
+
# backup. There can be only one pending backup creation per database. Backup
|
|
995
|
+
# creation of different databases can run concurrently.
|
|
988
996
|
#
|
|
989
997
|
# @overload create_backup(request, options = nil)
|
|
990
998
|
# Pass arguments to `create_backup` via a request object, either of type
|
|
@@ -996,7 +1004,7 @@ module Google
|
|
|
996
1004
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
997
1005
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
998
1006
|
#
|
|
999
|
-
# @overload create_backup(parent: nil, backup_id: nil, backup: nil)
|
|
1007
|
+
# @overload create_backup(parent: nil, backup_id: nil, backup: nil, encryption_config: nil)
|
|
1000
1008
|
# Pass arguments to `create_backup` via keyword arguments. Note that at
|
|
1001
1009
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1002
1010
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1014,6 +1022,12 @@ module Google
|
|
|
1014
1022
|
# `projects/<project>/instances/<instance>/backups/<backup_id>`.
|
|
1015
1023
|
# @param backup [::Google::Cloud::Spanner::Admin::Database::V1::Backup, ::Hash]
|
|
1016
1024
|
# Required. The backup to create.
|
|
1025
|
+
# @param encryption_config [::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig, ::Hash]
|
|
1026
|
+
# Optional. The encryption configuration used to encrypt the backup. If this
|
|
1027
|
+
# field is not specified, the backup will use the same encryption
|
|
1028
|
+
# configuration as the database by default, namely
|
|
1029
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type}
|
|
1030
|
+
# = `USE_DATABASE_ENCRYPTION`.
|
|
1017
1031
|
#
|
|
1018
1032
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1019
1033
|
# @yieldparam response [::Gapic::Operation]
|
|
@@ -1062,7 +1076,8 @@ module Google
|
|
|
1062
1076
|
end
|
|
1063
1077
|
|
|
1064
1078
|
##
|
|
1065
|
-
# Gets metadata on a pending or completed
|
|
1079
|
+
# Gets metadata on a pending or completed
|
|
1080
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
|
|
1066
1081
|
#
|
|
1067
1082
|
# @overload get_backup(request, options = nil)
|
|
1068
1083
|
# Pass arguments to `get_backup` via a request object, either of type
|
|
@@ -1130,7 +1145,8 @@ module Google
|
|
|
1130
1145
|
end
|
|
1131
1146
|
|
|
1132
1147
|
##
|
|
1133
|
-
# Updates a pending or completed
|
|
1148
|
+
# Updates a pending or completed
|
|
1149
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
|
|
1134
1150
|
#
|
|
1135
1151
|
# @overload update_backup(request, options = nil)
|
|
1136
1152
|
# Pass arguments to `update_backup` via a request object, either of type
|
|
@@ -1205,7 +1221,8 @@ module Google
|
|
|
1205
1221
|
end
|
|
1206
1222
|
|
|
1207
1223
|
##
|
|
1208
|
-
# Deletes a pending or completed
|
|
1224
|
+
# Deletes a pending or completed
|
|
1225
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
|
|
1209
1226
|
#
|
|
1210
1227
|
# @overload delete_backup(request, options = nil)
|
|
1211
1228
|
# Pass arguments to `delete_backup` via a request object, either of type
|
|
@@ -1304,13 +1321,16 @@ module Google
|
|
|
1304
1321
|
# must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
|
|
1305
1322
|
# Colon `:` is the contains operator. Filter rules are not case sensitive.
|
|
1306
1323
|
#
|
|
1307
|
-
# The following fields in the
|
|
1324
|
+
# The following fields in the
|
|
1325
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup} are eligible for
|
|
1326
|
+
# filtering:
|
|
1308
1327
|
#
|
|
1309
1328
|
# * `name`
|
|
1310
1329
|
# * `database`
|
|
1311
1330
|
# * `state`
|
|
1312
|
-
# * `create_time`
|
|
1313
|
-
# * `expire_time`
|
|
1331
|
+
# * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
|
|
1332
|
+
# * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
|
|
1333
|
+
# * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
|
|
1314
1334
|
# * `size_bytes`
|
|
1315
1335
|
#
|
|
1316
1336
|
# You can combine multiple expressions by enclosing each expression in
|
|
@@ -1335,9 +1355,10 @@ module Google
|
|
|
1335
1355
|
# less, defaults to the server's maximum allowed page size.
|
|
1336
1356
|
# @param page_token [::String]
|
|
1337
1357
|
# If non-empty, `page_token` should contain a
|
|
1338
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse#next_page_token next_page_token}
|
|
1339
|
-
#
|
|
1340
|
-
#
|
|
1358
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse#next_page_token next_page_token}
|
|
1359
|
+
# from a previous
|
|
1360
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse ListBackupsResponse}
|
|
1361
|
+
# to the same `parent` and with the same `filter`.
|
|
1341
1362
|
#
|
|
1342
1363
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1343
1364
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Spanner::Admin::Database::V1::Backup>]
|
|
@@ -1414,7 +1435,7 @@ module Google
|
|
|
1414
1435
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1415
1436
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1416
1437
|
#
|
|
1417
|
-
# @overload restore_database(parent: nil, database_id: nil, backup: nil)
|
|
1438
|
+
# @overload restore_database(parent: nil, database_id: nil, backup: nil, encryption_config: nil)
|
|
1418
1439
|
# Pass arguments to `restore_database` via keyword arguments. Note that at
|
|
1419
1440
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1420
1441
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1433,6 +1454,13 @@ module Google
|
|
|
1433
1454
|
# @param backup [::String]
|
|
1434
1455
|
# Name of the backup from which to restore. Values are of the form
|
|
1435
1456
|
# `projects/<project>/instances/<instance>/backups/<backup>`.
|
|
1457
|
+
# @param encryption_config [::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig, ::Hash]
|
|
1458
|
+
# Optional. An encryption configuration describing the encryption type and
|
|
1459
|
+
# key resources in Cloud KMS used to encrypt/decrypt the database to restore
|
|
1460
|
+
# to. If this field is not specified, the restored database will use the same
|
|
1461
|
+
# encryption configuration as the backup by default, namely
|
|
1462
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
|
|
1463
|
+
# = `USE_CONFIG_DEFAULT_OR_DATABASE_ENCRYPTION`.
|
|
1436
1464
|
#
|
|
1437
1465
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1438
1466
|
# @yieldparam response [::Gapic::Operation]
|
|
@@ -1523,7 +1551,9 @@ module Google
|
|
|
1523
1551
|
# * `name` - The name of the long-running operation
|
|
1524
1552
|
# * `done` - False if the operation is in progress, else true.
|
|
1525
1553
|
# * `metadata.@type` - the type of metadata. For example, the type string
|
|
1526
|
-
# for
|
|
1554
|
+
# for
|
|
1555
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}
|
|
1556
|
+
# is
|
|
1527
1557
|
# `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
|
|
1528
1558
|
# * `metadata.<field_name>` - any field in metadata.value.
|
|
1529
1559
|
# * `error` - Error associated with the long-running operation.
|
|
@@ -1543,7 +1573,8 @@ module Google
|
|
|
1543
1573
|
# `(metadata.name:restored_howl) AND` \
|
|
1544
1574
|
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
|
|
1545
1575
|
# `(error:*)` - Return operations where:
|
|
1546
|
-
# * The operation's metadata type is
|
|
1576
|
+
# * The operation's metadata type is
|
|
1577
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
|
|
1547
1578
|
# * The database is restored from a backup.
|
|
1548
1579
|
# * The backup name contains "backup_howl".
|
|
1549
1580
|
# * The restored database's name contains "restored_howl".
|
|
@@ -1555,8 +1586,9 @@ module Google
|
|
|
1555
1586
|
# @param page_token [::String]
|
|
1556
1587
|
# If non-empty, `page_token` should contain a
|
|
1557
1588
|
# {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse#next_page_token next_page_token}
|
|
1558
|
-
# from a previous
|
|
1559
|
-
#
|
|
1589
|
+
# from a previous
|
|
1590
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse}
|
|
1591
|
+
# to the same `parent` and with the same `filter`.
|
|
1560
1592
|
#
|
|
1561
1593
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1562
1594
|
# @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
|
|
@@ -1650,7 +1682,9 @@ module Google
|
|
|
1650
1682
|
# * `name` - The name of the long-running operation
|
|
1651
1683
|
# * `done` - False if the operation is in progress, else true.
|
|
1652
1684
|
# * `metadata.@type` - the type of metadata. For example, the type string
|
|
1653
|
-
# for
|
|
1685
|
+
# for
|
|
1686
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}
|
|
1687
|
+
# is
|
|
1654
1688
|
# `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
|
|
1655
1689
|
# * `metadata.<field_name>` - any field in metadata.value.
|
|
1656
1690
|
# * `error` - Error associated with the long-running operation.
|
|
@@ -1670,7 +1704,8 @@ module Google
|
|
|
1670
1704
|
# `(metadata.name:howl) AND` \
|
|
1671
1705
|
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
|
|
1672
1706
|
# `(error:*)` - Returns operations where:
|
|
1673
|
-
# * The operation's metadata type is
|
|
1707
|
+
# * The operation's metadata type is
|
|
1708
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
|
|
1674
1709
|
# * The backup name contains the string "howl".
|
|
1675
1710
|
# * The operation started before 2018-03-28T14:50:00Z.
|
|
1676
1711
|
# * The operation resulted in an error.
|
|
@@ -1680,8 +1715,9 @@ module Google
|
|
|
1680
1715
|
# @param page_token [::String]
|
|
1681
1716
|
# If non-empty, `page_token` should contain a
|
|
1682
1717
|
# {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse#next_page_token next_page_token}
|
|
1683
|
-
# from a previous
|
|
1684
|
-
#
|
|
1718
|
+
# from a previous
|
|
1719
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse ListBackupOperationsResponse}
|
|
1720
|
+
# to the same `parent` and with the same `filter`.
|
|
1685
1721
|
#
|
|
1686
1722
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1687
1723
|
# @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
|