google-cloud-spanner-admin-database-v1 0.1.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +64 -0
- data/lib/google/cloud/spanner/admin/database/v1.rb +3 -0
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb +31 -23
- data/lib/google/cloud/spanner/admin/database/v1/database_admin/operations.rb +90 -5
- data/lib/google/cloud/spanner/admin/database/v1/version.rb +1 -1
- data/lib/google/spanner/admin/database/v1/backup_pb.rb +2 -0
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb +3 -0
- data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +17 -17
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/api/resource.rb +50 -14
- 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/database/v1/backup.rb +21 -9
- data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb +23 -5
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6460dd9ef41667827ce9ab0fc647b0b95ba281c734003b2f7ade197f7d1c9191
|
4
|
+
data.tar.gz: fd9d1fec8ced5629b6d8c4fd2b723cc7494e615970ac724b05376c1f8c38cf23
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e92e530f7cd558be769c6e06f31ce2114dd705f4fb48e488ece3b7cff172744f3029beef6d485d159d3043945baee435c983677361d32d05e34db81e23abdc1a
|
7
|
+
data.tar.gz: 528a8fe8000757e73352007bd6c4dd3961776900c27434b9545c3183e2226d3ecbd9c639c674f17b311751a9fd423cee7f9f3254b1c1afe5eb7deee313ba952e
|
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 Database Admin V1 API. Most users should consider using
|
11
|
+
the main client gem,
|
12
|
+
[google-cloud-spanner-admin-database](https://rubygems.org/gems/google-cloud-spanner-admin-database).
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
14
|
+
|
9
15
|
## Installation
|
10
16
|
|
11
17
|
```
|
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
|
|
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-database`,
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
88
|
+
`google-cloud-spanner-admin-database-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-database`.
|
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-database-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.
|
@@ -77,7 +77,7 @@ module Google
|
|
77
77
|
initial_delay: 1.0,
|
78
78
|
max_delay: 32.0,
|
79
79
|
multiplier: 1.3,
|
80
|
-
retry_codes: [
|
80
|
+
retry_codes: [14, 4]
|
81
81
|
}
|
82
82
|
|
83
83
|
default_config.rpcs.create_database.timeout = 3600.0
|
@@ -87,7 +87,7 @@ module Google
|
|
87
87
|
initial_delay: 1.0,
|
88
88
|
max_delay: 32.0,
|
89
89
|
multiplier: 1.3,
|
90
|
-
retry_codes: [
|
90
|
+
retry_codes: [14, 4]
|
91
91
|
}
|
92
92
|
|
93
93
|
default_config.rpcs.update_database_ddl.timeout = 3600.0
|
@@ -95,7 +95,7 @@ module Google
|
|
95
95
|
initial_delay: 1.0,
|
96
96
|
max_delay: 32.0,
|
97
97
|
multiplier: 1.3,
|
98
|
-
retry_codes: [
|
98
|
+
retry_codes: [14, 4]
|
99
99
|
}
|
100
100
|
|
101
101
|
default_config.rpcs.drop_database.timeout = 3600.0
|
@@ -103,7 +103,7 @@ module Google
|
|
103
103
|
initial_delay: 1.0,
|
104
104
|
max_delay: 32.0,
|
105
105
|
multiplier: 1.3,
|
106
|
-
retry_codes: [
|
106
|
+
retry_codes: [14, 4]
|
107
107
|
}
|
108
108
|
|
109
109
|
default_config.rpcs.get_database_ddl.timeout = 3600.0
|
@@ -111,7 +111,7 @@ module Google
|
|
111
111
|
initial_delay: 1.0,
|
112
112
|
max_delay: 32.0,
|
113
113
|
multiplier: 1.3,
|
114
|
-
retry_codes: [
|
114
|
+
retry_codes: [14, 4]
|
115
115
|
}
|
116
116
|
|
117
117
|
default_config.rpcs.set_iam_policy.timeout = 30.0
|
@@ -121,7 +121,7 @@ module Google
|
|
121
121
|
initial_delay: 1.0,
|
122
122
|
max_delay: 32.0,
|
123
123
|
multiplier: 1.3,
|
124
|
-
retry_codes: [
|
124
|
+
retry_codes: [14, 4]
|
125
125
|
}
|
126
126
|
|
127
127
|
default_config.rpcs.test_iam_permissions.timeout = 30.0
|
@@ -133,7 +133,7 @@ module Google
|
|
133
133
|
initial_delay: 1.0,
|
134
134
|
max_delay: 32.0,
|
135
135
|
multiplier: 1.3,
|
136
|
-
retry_codes: [
|
136
|
+
retry_codes: [14, 4]
|
137
137
|
}
|
138
138
|
|
139
139
|
default_config.rpcs.update_backup.timeout = 3600.0
|
@@ -141,7 +141,7 @@ module Google
|
|
141
141
|
initial_delay: 1.0,
|
142
142
|
max_delay: 32.0,
|
143
143
|
multiplier: 1.3,
|
144
|
-
retry_codes: [
|
144
|
+
retry_codes: [14, 4]
|
145
145
|
}
|
146
146
|
|
147
147
|
default_config.rpcs.delete_backup.timeout = 3600.0
|
@@ -149,7 +149,7 @@ module Google
|
|
149
149
|
initial_delay: 1.0,
|
150
150
|
max_delay: 32.0,
|
151
151
|
multiplier: 1.3,
|
152
|
-
retry_codes: [
|
152
|
+
retry_codes: [14, 4]
|
153
153
|
}
|
154
154
|
|
155
155
|
default_config.rpcs.list_backups.timeout = 3600.0
|
@@ -157,7 +157,7 @@ module Google
|
|
157
157
|
initial_delay: 1.0,
|
158
158
|
max_delay: 32.0,
|
159
159
|
multiplier: 1.3,
|
160
|
-
retry_codes: [
|
160
|
+
retry_codes: [14, 4]
|
161
161
|
}
|
162
162
|
|
163
163
|
default_config.rpcs.restore_database.timeout = 3600.0
|
@@ -167,7 +167,7 @@ module Google
|
|
167
167
|
initial_delay: 1.0,
|
168
168
|
max_delay: 32.0,
|
169
169
|
multiplier: 1.3,
|
170
|
-
retry_codes: [
|
170
|
+
retry_codes: [14, 4]
|
171
171
|
}
|
172
172
|
|
173
173
|
default_config.rpcs.list_backup_operations.timeout = 3600.0
|
@@ -175,7 +175,7 @@ module Google
|
|
175
175
|
initial_delay: 1.0,
|
176
176
|
max_delay: 32.0,
|
177
177
|
multiplier: 1.3,
|
178
|
-
retry_codes: [
|
178
|
+
retry_codes: [14, 4]
|
179
179
|
}
|
180
180
|
|
181
181
|
default_config
|
@@ -239,7 +239,13 @@ module Google
|
|
239
239
|
|
240
240
|
# Create credentials
|
241
241
|
credentials = @config.credentials
|
242
|
-
|
242
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
243
|
+
# but only if the default endpoint does not have a region prefix.
|
244
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
245
|
+
@config.endpoint == Client.configure.endpoint &&
|
246
|
+
!@config.endpoint.split(".").first.include?("-")
|
247
|
+
credentials ||= Credentials.default scope: @config.scope,
|
248
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
243
249
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
244
250
|
credentials = Credentials.new credentials, scope: @config.scope
|
245
251
|
end
|
@@ -682,6 +688,8 @@ module Google
|
|
682
688
|
#
|
683
689
|
# @param database [::String]
|
684
690
|
# Required. The database whose schema we wish to get.
|
691
|
+
# Values are of the form
|
692
|
+
# `projects/<project>/instances/<instance>/databases/<database>`
|
685
693
|
#
|
686
694
|
# @yield [response, operation] Access the result along with the RPC operation
|
687
695
|
# @yieldparam response [::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse]
|
@@ -1529,11 +1537,11 @@ module Google
|
|
1529
1537
|
# Here are a few examples:
|
1530
1538
|
#
|
1531
1539
|
# * `done:true` - The operation is complete.
|
1532
|
-
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND`
|
1533
|
-
# `(metadata.source_type:BACKUP) AND`
|
1534
|
-
# `(metadata.backup_info.backup:backup_howl) AND`
|
1535
|
-
# `(metadata.name:restored_howl) AND`
|
1536
|
-
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
|
1540
|
+
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
|
1541
|
+
# `(metadata.source_type:BACKUP) AND` \
|
1542
|
+
# `(metadata.backup_info.backup:backup_howl) AND` \
|
1543
|
+
# `(metadata.name:restored_howl) AND` \
|
1544
|
+
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
|
1537
1545
|
# `(error:*)` - Return operations where:
|
1538
1546
|
# * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
|
1539
1547
|
# * The database is restored from a backup.
|
@@ -1658,9 +1666,9 @@ module Google
|
|
1658
1666
|
# * `done:true` - The operation is complete.
|
1659
1667
|
# * `metadata.database:prod` - The database the backup was taken from has
|
1660
1668
|
# a name containing the string "prod".
|
1661
|
-
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND`
|
1662
|
-
# `(metadata.name:howl) AND`
|
1663
|
-
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
|
1669
|
+
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
|
1670
|
+
# `(metadata.name:howl) AND` \
|
1671
|
+
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
|
1664
1672
|
# `(error:*)` - Returns operations where:
|
1665
1673
|
# * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
|
1666
1674
|
# * The backup name contains the string "howl".
|
@@ -1807,7 +1815,7 @@ module Google
|
|
1807
1815
|
|
1808
1816
|
config_attr :endpoint, "spanner.googleapis.com", ::String
|
1809
1817
|
config_attr :credentials, nil do |value|
|
1810
|
-
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1818
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1811
1819
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
1812
1820
|
allowed.any? { |klass| klass === value }
|
1813
1821
|
end
|
@@ -1847,7 +1855,7 @@ module Google
|
|
1847
1855
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
1848
1856
|
# the following configuration fields:
|
1849
1857
|
#
|
1850
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
1858
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
1851
1859
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
1852
1860
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
1853
1861
|
# include the following keys:
|
@@ -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::Database::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
|
#
|
@@ -477,7 +555,7 @@ module Google
|
|
477
555
|
|
478
556
|
config_attr :endpoint, "spanner.googleapis.com", ::String
|
479
557
|
config_attr :credentials, nil do |value|
|
480
|
-
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
558
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
481
559
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
482
560
|
allowed.any? { |klass| klass === value }
|
483
561
|
end
|
@@ -517,7 +595,7 @@ module Google
|
|
517
595
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
518
596
|
# the following configuration fields:
|
519
597
|
#
|
520
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
598
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
521
599
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
522
600
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
523
601
|
# include the following keys:
|
@@ -548,6 +626,11 @@ 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
|
@@ -559,6 +642,8 @@ module Google
|
|
559
642
|
@delete_operation = ::Gapic::Config::Method.new delete_operation_config
|
560
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
|
@@ -14,6 +14,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
14
14
|
add_file("google/spanner/admin/database/v1/backup.proto", :syntax => :proto3) do
|
15
15
|
add_message "google.spanner.admin.database.v1.Backup" do
|
16
16
|
optional :database, :string, 2
|
17
|
+
optional :version_time, :message, 9, "google.protobuf.Timestamp"
|
17
18
|
optional :expire_time, :message, 3, "google.protobuf.Timestamp"
|
18
19
|
optional :name, :string, 1
|
19
20
|
optional :create_time, :message, 4, "google.protobuf.Timestamp"
|
@@ -69,6 +70,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
69
70
|
end
|
70
71
|
add_message "google.spanner.admin.database.v1.BackupInfo" do
|
71
72
|
optional :backup, :string, 1
|
73
|
+
optional :version_time, :message, 4, "google.protobuf.Timestamp"
|
72
74
|
optional :create_time, :message, 2, "google.protobuf.Timestamp"
|
73
75
|
optional :source_database, :string, 3
|
74
76
|
end
|
@@ -27,6 +27,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
27
27
|
optional :state, :enum, 2, "google.spanner.admin.database.v1.Database.State"
|
28
28
|
optional :create_time, :message, 3, "google.protobuf.Timestamp"
|
29
29
|
optional :restore_info, :message, 4, "google.spanner.admin.database.v1.RestoreInfo"
|
30
|
+
optional :version_retention_period, :string, 6
|
31
|
+
optional :earliest_version_time, :message, 7, "google.protobuf.Timestamp"
|
30
32
|
end
|
31
33
|
add_enum "google.spanner.admin.database.v1.Database.State" do
|
32
34
|
value :STATE_UNSPECIFIED, 0
|
@@ -63,6 +65,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
63
65
|
optional :database, :string, 1
|
64
66
|
repeated :statements, :string, 2
|
65
67
|
repeated :commit_timestamps, :message, 3, "google.protobuf.Timestamp"
|
68
|
+
optional :throttled, :bool, 4
|
66
69
|
end
|
67
70
|
add_message "google.spanner.admin.database.v1.DropDatabaseRequest" do
|
68
71
|
optional :database, :string, 1
|
@@ -41,7 +41,7 @@ module Google
|
|
41
41
|
self.service_name = 'google.spanner.admin.database.v1.DatabaseAdmin'
|
42
42
|
|
43
43
|
# Lists Cloud Spanner databases.
|
44
|
-
rpc :ListDatabases, Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesRequest, Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse
|
44
|
+
rpc :ListDatabases, ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesRequest, ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse
|
45
45
|
# Creates a new Cloud Spanner database and starts to prepare it for serving.
|
46
46
|
# The returned [long-running operation][google.longrunning.Operation] will
|
47
47
|
# have a name of the format `<database_name>/operations/<operation_id>` and
|
@@ -50,9 +50,9 @@ module Google
|
|
50
50
|
# [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
|
51
51
|
# [response][google.longrunning.Operation.response] field type is
|
52
52
|
# [Database][google.spanner.admin.database.v1.Database], if successful.
|
53
|
-
rpc :CreateDatabase, Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest, Google::Longrunning::Operation
|
53
|
+
rpc :CreateDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest, ::Google::Longrunning::Operation
|
54
54
|
# Gets the state of a Cloud Spanner database.
|
55
|
-
rpc :GetDatabase, Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseRequest, Google::Cloud::Spanner::Admin::Database::V1::Database
|
55
|
+
rpc :GetDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseRequest, ::Google::Cloud::Spanner::Admin::Database::V1::Database
|
56
56
|
# Updates the schema of a Cloud Spanner database by
|
57
57
|
# creating/altering/dropping tables, columns, indexes, etc. The returned
|
58
58
|
# [long-running operation][google.longrunning.Operation] will have a name of
|
@@ -60,15 +60,15 @@ module Google
|
|
60
60
|
# track execution of the schema change(s). The
|
61
61
|
# [metadata][google.longrunning.Operation.metadata] field type is
|
62
62
|
# [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.
|
63
|
-
rpc :UpdateDatabaseDdl, Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest, Google::Longrunning::Operation
|
63
|
+
rpc :UpdateDatabaseDdl, ::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest, ::Google::Longrunning::Operation
|
64
64
|
# Drops (aka deletes) a Cloud Spanner database.
|
65
65
|
# Completed backups for the database will be retained according to their
|
66
66
|
# `expire_time`.
|
67
|
-
rpc :DropDatabase, Google::Cloud::Spanner::Admin::Database::V1::DropDatabaseRequest, Google::Protobuf::Empty
|
67
|
+
rpc :DropDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::DropDatabaseRequest, ::Google::Protobuf::Empty
|
68
68
|
# Returns the schema of a Cloud Spanner database as a list of formatted
|
69
69
|
# DDL statements. This method does not show pending schema updates, those may
|
70
70
|
# be queried using the [Operations][google.longrunning.Operations] API.
|
71
|
-
rpc :GetDatabaseDdl, Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlRequest, Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse
|
71
|
+
rpc :GetDatabaseDdl, ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlRequest, ::Google::Cloud::Spanner::Admin::Database::V1::GetDatabaseDdlResponse
|
72
72
|
# Sets the access control policy on a database or backup resource.
|
73
73
|
# Replaces any existing policy.
|
74
74
|
#
|
@@ -76,7 +76,7 @@ module Google
|
|
76
76
|
# permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
|
77
77
|
# For backups, authorization requires `spanner.backups.setIamPolicy`
|
78
78
|
# permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
|
79
|
-
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
79
|
+
rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
|
80
80
|
# Gets the access control policy for a database or backup resource.
|
81
81
|
# Returns an empty policy if a database or backup exists but does not have a
|
82
82
|
# policy set.
|
@@ -85,7 +85,7 @@ module Google
|
|
85
85
|
# [resource][google.iam.v1.GetIamPolicyRequest.resource].
|
86
86
|
# For backups, authorization requires `spanner.backups.getIamPolicy`
|
87
87
|
# permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
|
88
|
-
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
88
|
+
rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
|
89
89
|
# Returns permissions that the caller has on the specified database or backup
|
90
90
|
# resource.
|
91
91
|
#
|
@@ -96,7 +96,7 @@ module Google
|
|
96
96
|
# Calling this method on a backup that does not exist will
|
97
97
|
# result in a NOT_FOUND error if the user has
|
98
98
|
# `spanner.backups.list` permission on the containing instance.
|
99
|
-
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
99
|
+
rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
|
100
100
|
# Starts creating a new Cloud Spanner Backup.
|
101
101
|
# The returned backup [long-running operation][google.longrunning.Operation]
|
102
102
|
# will have a name of the format
|
@@ -109,17 +109,17 @@ module Google
|
|
109
109
|
# creation and delete the backup.
|
110
110
|
# There can be only one pending backup creation per database. Backup creation
|
111
111
|
# of different databases can run concurrently.
|
112
|
-
rpc :CreateBackup, Google::Cloud::Spanner::Admin::Database::V1::CreateBackupRequest, Google::Longrunning::Operation
|
112
|
+
rpc :CreateBackup, ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupRequest, ::Google::Longrunning::Operation
|
113
113
|
# Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
|
114
|
-
rpc :GetBackup, Google::Cloud::Spanner::Admin::Database::V1::GetBackupRequest, Google::Cloud::Spanner::Admin::Database::V1::Backup
|
114
|
+
rpc :GetBackup, ::Google::Cloud::Spanner::Admin::Database::V1::GetBackupRequest, ::Google::Cloud::Spanner::Admin::Database::V1::Backup
|
115
115
|
# Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
|
116
|
-
rpc :UpdateBackup, Google::Cloud::Spanner::Admin::Database::V1::UpdateBackupRequest, Google::Cloud::Spanner::Admin::Database::V1::Backup
|
116
|
+
rpc :UpdateBackup, ::Google::Cloud::Spanner::Admin::Database::V1::UpdateBackupRequest, ::Google::Cloud::Spanner::Admin::Database::V1::Backup
|
117
117
|
# Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
|
118
|
-
rpc :DeleteBackup, Google::Cloud::Spanner::Admin::Database::V1::DeleteBackupRequest, Google::Protobuf::Empty
|
118
|
+
rpc :DeleteBackup, ::Google::Cloud::Spanner::Admin::Database::V1::DeleteBackupRequest, ::Google::Protobuf::Empty
|
119
119
|
# Lists completed and pending backups.
|
120
120
|
# Backups returned are ordered by `create_time` in descending order,
|
121
121
|
# starting from the most recent `create_time`.
|
122
|
-
rpc :ListBackups, Google::Cloud::Spanner::Admin::Database::V1::ListBackupsRequest, Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse
|
122
|
+
rpc :ListBackups, ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsRequest, ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse
|
123
123
|
# Create a new database by restoring from a completed backup. The new
|
124
124
|
# database must be in the same project and in an instance with the same
|
125
125
|
# instance configuration as the instance containing
|
@@ -137,7 +137,7 @@ module Google
|
|
137
137
|
# Once the restore operation completes, a new restore operation can be
|
138
138
|
# initiated, without waiting for the optimize operation associated with the
|
139
139
|
# first restore to complete.
|
140
|
-
rpc :RestoreDatabase, Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseRequest, Google::Longrunning::Operation
|
140
|
+
rpc :RestoreDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseRequest, ::Google::Longrunning::Operation
|
141
141
|
# Lists database [longrunning-operations][google.longrunning.Operation].
|
142
142
|
# A database operation has a name of the form
|
143
143
|
# `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.
|
@@ -146,7 +146,7 @@ module Google
|
|
146
146
|
# `metadata.type_url` describes the type of the metadata. Operations returned
|
147
147
|
# include those that have completed/failed/canceled within the last 7 days,
|
148
148
|
# and pending operations.
|
149
|
-
rpc :ListDatabaseOperations, Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsRequest, Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse
|
149
|
+
rpc :ListDatabaseOperations, ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsRequest, ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse
|
150
150
|
# Lists the backup [long-running operations][google.longrunning.Operation] in
|
151
151
|
# the given instance. A backup operation has a name of the form
|
152
152
|
# `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`.
|
@@ -157,7 +157,7 @@ module Google
|
|
157
157
|
# and pending operations. Operations returned are ordered by
|
158
158
|
# `operation.metadata.value.progress.start_time` in descending order starting
|
159
159
|
# from the most recently started operation.
|
160
|
-
rpc :ListBackupOperations, Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsRequest, Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse
|
160
|
+
rpc :ListBackupOperations, ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsRequest, ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse
|
161
161
|
end
|
162
162
|
|
163
163
|
Stub = Service.rpc_stub_class
|
@@ -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
|
@@ -43,12 +43,12 @@ module Google
|
|
43
43
|
#
|
44
44
|
# The ResourceDescriptor Yaml config will look like:
|
45
45
|
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
52
52
|
#
|
53
53
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
54
|
# live under multiple parents.
|
@@ -183,15 +183,24 @@ module Google
|
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
185
|
# @return [::String]
|
186
|
-
# The plural name used in the resource name, such as
|
187
|
-
# the name of 'projects/\\{project}'
|
188
|
-
#
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
189
190
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
191
|
+
#
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
193
|
+
# https://aip.dev/156
|
190
194
|
# @!attribute [rw] singular
|
191
195
|
# @return [::String]
|
192
196
|
# The same concept of the `singular` field in k8s CRD spec
|
193
197
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
198
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
199
|
+
# @!attribute [rw] style
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
201
|
+
# Style flag(s) for this resource.
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
203
|
+
# style. See the specific style flags for additional information.
|
195
204
|
class ResourceDescriptor
|
196
205
|
include ::Google::Protobuf::MessageExts
|
197
206
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,6 +220,22 @@ module Google
|
|
211
220
|
# that from being necessary once there are multiple patterns.)
|
212
221
|
FUTURE_MULTI_PATTERN = 2
|
213
222
|
end
|
223
|
+
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
225
|
+
module Style
|
226
|
+
# The unspecified value. Do not use.
|
227
|
+
STYLE_UNSPECIFIED = 0
|
228
|
+
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
230
|
+
#
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
232
|
+
# setting this to true communicates to tools that this resource should
|
233
|
+
# adhere to declarative-friendly expectations.
|
234
|
+
#
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
236
|
+
# additional checks.
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
238
|
+
end
|
214
239
|
end
|
215
240
|
|
216
241
|
# Defines a proto annotation that describes a string field that refers to
|
@@ -226,6 +251,17 @@ module Google
|
|
226
251
|
# type: "pubsub.googleapis.com/Topic"
|
227
252
|
# }];
|
228
253
|
# }
|
254
|
+
#
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
256
|
+
# APIs use the special value * in their resource reference.
|
257
|
+
#
|
258
|
+
# Example:
|
259
|
+
#
|
260
|
+
# message GetIamPolicyRequest {
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
262
|
+
# type: "*"
|
263
|
+
# }];
|
264
|
+
# }
|
229
265
|
# @!attribute [rw] child_type
|
230
266
|
# @return [::String]
|
231
267
|
# The resource type of a child collection that the annotated field
|
@@ -234,11 +270,11 @@ module Google
|
|
234
270
|
#
|
235
271
|
# Example:
|
236
272
|
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
273
|
+
# message ListLogEntriesRequest {
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
276
|
+
# };
|
277
|
+
# }
|
242
278
|
class ResourceReference
|
243
279
|
include ::Google::Protobuf::MessageExts
|
244
280
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -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()
|
@@ -31,6 +31,12 @@ module Google
|
|
31
31
|
# created. This needs to be in the same instance as the backup.
|
32
32
|
# Values are of the form
|
33
33
|
# `projects/<project>/instances/<instance>/databases/<database>`.
|
34
|
+
# @!attribute [rw] version_time
|
35
|
+
# @return [::Google::Protobuf::Timestamp]
|
36
|
+
# The backup will contain an externally consistent copy of the database at
|
37
|
+
# the timestamp specified by `version_time`. If `version_time` is not
|
38
|
+
# specified, the system will set `version_time` to the `create_time` of the
|
39
|
+
# backup.
|
34
40
|
# @!attribute [rw] expire_time
|
35
41
|
# @return [::Google::Protobuf::Timestamp]
|
36
42
|
# Required for the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
|
@@ -56,10 +62,9 @@ module Google
|
|
56
62
|
# `projects/<project>/instances/<instance>`.
|
57
63
|
# @!attribute [r] create_time
|
58
64
|
# @return [::Google::Protobuf::Timestamp]
|
59
|
-
# Output only. The
|
60
|
-
#
|
61
|
-
# `
|
62
|
-
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} request is received.
|
65
|
+
# Output only. The time the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
|
66
|
+
# request is received. If the request does not specify `version_time`, the
|
67
|
+
# `version_time` of the backup will be equivalent to the `create_time`.
|
63
68
|
# @!attribute [r] size_bytes
|
64
69
|
# @return [::Integer]
|
65
70
|
# Output only. Size of the backup in bytes.
|
@@ -295,9 +300,9 @@ module Google
|
|
295
300
|
# * `done:true` - The operation is complete.
|
296
301
|
# * `metadata.database:prod` - The database the backup was taken from has
|
297
302
|
# a name containing the string "prod".
|
298
|
-
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND`
|
299
|
-
# `(metadata.name:howl) AND`
|
300
|
-
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
|
303
|
+
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
|
304
|
+
# `(metadata.name:howl) AND` \
|
305
|
+
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
|
301
306
|
# `(error:*)` - Returns operations where:
|
302
307
|
# * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
|
303
308
|
# * The backup name contains the string "howl".
|
@@ -345,10 +350,17 @@ module Google
|
|
345
350
|
# @!attribute [rw] backup
|
346
351
|
# @return [::String]
|
347
352
|
# Name of the backup.
|
348
|
-
# @!attribute [rw]
|
353
|
+
# @!attribute [rw] version_time
|
349
354
|
# @return [::Google::Protobuf::Timestamp]
|
350
355
|
# The backup contains an externally consistent copy of `source_database` at
|
351
|
-
# the timestamp specified by `
|
356
|
+
# the timestamp specified by `version_time`. If the
|
357
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} request did not specify
|
358
|
+
# `version_time`, the `version_time` of the backup is equivalent to the
|
359
|
+
# `create_time`.
|
360
|
+
# @!attribute [rw] create_time
|
361
|
+
# @return [::Google::Protobuf::Timestamp]
|
362
|
+
# The time the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} request was
|
363
|
+
# received.
|
352
364
|
# @!attribute [rw] source_database
|
353
365
|
# @return [::String]
|
354
366
|
# Name of the database the backup was created from.
|
@@ -54,6 +54,17 @@ module Google
|
|
54
54
|
# @return [::Google::Cloud::Spanner::Admin::Database::V1::RestoreInfo]
|
55
55
|
# Output only. Applicable only for restored databases. Contains information
|
56
56
|
# about the restore source.
|
57
|
+
# @!attribute [r] version_retention_period
|
58
|
+
# @return [::String]
|
59
|
+
# Output only. The period in which Cloud Spanner retains all versions of data
|
60
|
+
# for the database. This is the same as the value of version_retention_period
|
61
|
+
# database option set using
|
62
|
+
# {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}. Defaults to 1 hour,
|
63
|
+
# if not set.
|
64
|
+
# @!attribute [r] earliest_version_time
|
65
|
+
# @return [::Google::Protobuf::Timestamp]
|
66
|
+
# Output only. Earliest timestamp at which older versions of the data can be
|
67
|
+
# read.
|
57
68
|
class Database
|
58
69
|
include ::Google::Protobuf::MessageExts
|
59
70
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -220,6 +231,11 @@ module Google
|
|
220
231
|
# Reports the commit timestamps of all statements that have
|
221
232
|
# succeeded so far, where `commit_timestamps[i]` is the commit
|
222
233
|
# timestamp for the statement `statements[i]`.
|
234
|
+
# @!attribute [r] throttled
|
235
|
+
# @return [::Boolean]
|
236
|
+
# Output only. When true, indicates that the operation is throttled e.g
|
237
|
+
# due to resource constraints. When resources become available the operation
|
238
|
+
# will resume and this field will be false again.
|
223
239
|
class UpdateDatabaseDdlMetadata
|
224
240
|
include ::Google::Protobuf::MessageExts
|
225
241
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -238,6 +254,8 @@ module Google
|
|
238
254
|
# @!attribute [rw] database
|
239
255
|
# @return [::String]
|
240
256
|
# Required. The database whose schema we wish to get.
|
257
|
+
# Values are of the form
|
258
|
+
# `projects/<project>/instances/<instance>/databases/<database>`
|
241
259
|
class GetDatabaseDdlRequest
|
242
260
|
include ::Google::Protobuf::MessageExts
|
243
261
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -289,11 +307,11 @@ module Google
|
|
289
307
|
# Here are a few examples:
|
290
308
|
#
|
291
309
|
# * `done:true` - The operation is complete.
|
292
|
-
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND`
|
293
|
-
# `(metadata.source_type:BACKUP) AND`
|
294
|
-
# `(metadata.backup_info.backup:backup_howl) AND`
|
295
|
-
# `(metadata.name:restored_howl) AND`
|
296
|
-
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
|
310
|
+
# * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
|
311
|
+
# `(metadata.source_type:BACKUP) AND` \
|
312
|
+
# `(metadata.backup_info.backup:backup_howl) AND` \
|
313
|
+
# `(metadata.name:restored_howl) AND` \
|
314
|
+
# `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
|
297
315
|
# `(error:*)` - Return operations where:
|
298
316
|
# * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
|
299
317
|
# * The database is restored from a backup.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-spanner-admin-database-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.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:
|
11
|
+
date: 2021-02-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -171,7 +171,10 @@ dependencies:
|
|
171
171
|
- !ruby/object:Gem::Version
|
172
172
|
version: '0.9'
|
173
173
|
description: Cloud Spanner is a managed, mission-critical, globally consistent and
|
174
|
-
scalable relational database service.
|
174
|
+
scalable relational database service. Note that google-cloud-spanner-admin-database-v1
|
175
|
+
is a version-specific client library. For most uses, we recommend installing the
|
176
|
+
main client library google-cloud-spanner-admin-database instead. See the readme
|
177
|
+
for more details.
|
175
178
|
email: googleapis-packages@google.com
|
176
179
|
executables: []
|
177
180
|
extensions: []
|
@@ -201,6 +204,7 @@ files:
|
|
201
204
|
- proto_docs/google/iam/v1/policy.rb
|
202
205
|
- proto_docs/google/longrunning/operations.rb
|
203
206
|
- proto_docs/google/protobuf/any.rb
|
207
|
+
- proto_docs/google/protobuf/duration.rb
|
204
208
|
- proto_docs/google/protobuf/empty.rb
|
205
209
|
- proto_docs/google/protobuf/field_mask.rb
|
206
210
|
- proto_docs/google/protobuf/timestamp.rb
|
@@ -228,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
228
232
|
- !ruby/object:Gem::Version
|
229
233
|
version: '0'
|
230
234
|
requirements: []
|
231
|
-
rubygems_version: 3.
|
235
|
+
rubygems_version: 3.2.6
|
232
236
|
signing_key:
|
233
237
|
specification_version: 4
|
234
238
|
summary: API Client library for the Cloud Spanner Database Admin V1 API
|