google-cloud-firestore-admin-v1 0.3.2 → 0.4.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/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +3 -3
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +595 -73
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +145 -33
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb +14 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin.rb +26 -0
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/database_pb.rb +46 -0
- data/lib/google/firestore/admin/v1/field_pb.rb +3 -2
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +25 -2
- data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb +38 -4
- data/lib/google/firestore/admin/v1/index_pb.rb +2 -2
- data/lib/google/firestore/admin/v1/location_pb.rb +2 -2
- data/lib/google/firestore/admin/v1/operation_pb.rb +2 -2
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/firestore/admin/v1/database.rb +91 -0
- data/proto_docs/google/firestore/admin/v1/field.rb +1 -1
- data/proto_docs/google/firestore/admin/v1/firestore_admin.rb +49 -2
- data/proto_docs/google/firestore/admin/v1/index.rb +1 -1
- metadata +8 -7
@@ -144,6 +144,27 @@ module Google
|
|
144
144
|
#
|
145
145
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
146
146
|
#
|
147
|
+
# @example Basic example
|
148
|
+
# require "google/longrunning"
|
149
|
+
#
|
150
|
+
# # Create a client object. The client can be reused for multiple calls.
|
151
|
+
# client = Google::Longrunning::Operations::Client.new
|
152
|
+
#
|
153
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
154
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
155
|
+
#
|
156
|
+
# # Call the list_operations method.
|
157
|
+
# result = client.list_operations request
|
158
|
+
#
|
159
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
160
|
+
# # iterate over all elements by calling #each, and the enumerable
|
161
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
162
|
+
# # methods are also available for managing paging directly.
|
163
|
+
# result.each do |response|
|
164
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
165
|
+
# p response
|
166
|
+
# end
|
167
|
+
#
|
147
168
|
def list_operations request, options = nil
|
148
169
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
149
170
|
|
@@ -161,16 +182,20 @@ module Google
|
|
161
182
|
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
162
183
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
163
184
|
|
164
|
-
header_params = {
|
165
|
-
|
166
|
-
|
185
|
+
header_params = {}
|
186
|
+
if request.name
|
187
|
+
header_params["name"] = request.name
|
188
|
+
end
|
189
|
+
|
167
190
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
168
191
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
169
192
|
|
170
193
|
options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
|
171
194
|
metadata: metadata,
|
172
195
|
retry_policy: @config.rpcs.list_operations.retry_policy
|
173
|
-
|
196
|
+
|
197
|
+
options.apply_defaults timeout: @config.timeout,
|
198
|
+
metadata: @config.metadata,
|
174
199
|
retry_policy: @config.retry_policy
|
175
200
|
|
176
201
|
@operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
|
@@ -214,6 +239,28 @@ module Google
|
|
214
239
|
#
|
215
240
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
216
241
|
#
|
242
|
+
# @example Basic example
|
243
|
+
# require "google/longrunning"
|
244
|
+
#
|
245
|
+
# # Create a client object. The client can be reused for multiple calls.
|
246
|
+
# client = Google::Longrunning::Operations::Client.new
|
247
|
+
#
|
248
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
249
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
250
|
+
#
|
251
|
+
# # Call the get_operation method.
|
252
|
+
# result = client.get_operation request
|
253
|
+
#
|
254
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
255
|
+
# # object to check the status of an operation, cancel it, or wait
|
256
|
+
# # for results. Here is how to block until completion:
|
257
|
+
# result.wait_until_done! timeout: 60
|
258
|
+
# if result.response?
|
259
|
+
# p result.response
|
260
|
+
# else
|
261
|
+
# puts "Error!"
|
262
|
+
# end
|
263
|
+
#
|
217
264
|
def get_operation request, options = nil
|
218
265
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
219
266
|
|
@@ -231,16 +278,20 @@ module Google
|
|
231
278
|
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
232
279
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
233
280
|
|
234
|
-
header_params = {
|
235
|
-
|
236
|
-
|
281
|
+
header_params = {}
|
282
|
+
if request.name
|
283
|
+
header_params["name"] = request.name
|
284
|
+
end
|
285
|
+
|
237
286
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
238
287
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
239
288
|
|
240
289
|
options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
|
241
290
|
metadata: metadata,
|
242
291
|
retry_policy: @config.rpcs.get_operation.retry_policy
|
243
|
-
|
292
|
+
|
293
|
+
options.apply_defaults timeout: @config.timeout,
|
294
|
+
metadata: @config.metadata,
|
244
295
|
retry_policy: @config.retry_policy
|
245
296
|
|
246
297
|
@operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
|
@@ -284,6 +335,21 @@ module Google
|
|
284
335
|
#
|
285
336
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
286
337
|
#
|
338
|
+
# @example Basic example
|
339
|
+
# require "google/longrunning"
|
340
|
+
#
|
341
|
+
# # Create a client object. The client can be reused for multiple calls.
|
342
|
+
# client = Google::Longrunning::Operations::Client.new
|
343
|
+
#
|
344
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
345
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
346
|
+
#
|
347
|
+
# # Call the delete_operation method.
|
348
|
+
# result = client.delete_operation request
|
349
|
+
#
|
350
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
351
|
+
# p result
|
352
|
+
#
|
287
353
|
def delete_operation request, options = nil
|
288
354
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
289
355
|
|
@@ -301,16 +367,20 @@ module Google
|
|
301
367
|
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
302
368
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
303
369
|
|
304
|
-
header_params = {
|
305
|
-
|
306
|
-
|
370
|
+
header_params = {}
|
371
|
+
if request.name
|
372
|
+
header_params["name"] = request.name
|
373
|
+
end
|
374
|
+
|
307
375
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
308
376
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
309
377
|
|
310
378
|
options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
|
311
379
|
metadata: metadata,
|
312
380
|
retry_policy: @config.rpcs.delete_operation.retry_policy
|
313
|
-
|
381
|
+
|
382
|
+
options.apply_defaults timeout: @config.timeout,
|
383
|
+
metadata: @config.metadata,
|
314
384
|
retry_policy: @config.retry_policy
|
315
385
|
|
316
386
|
@operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
|
@@ -359,6 +429,21 @@ module Google
|
|
359
429
|
#
|
360
430
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
361
431
|
#
|
432
|
+
# @example Basic example
|
433
|
+
# require "google/longrunning"
|
434
|
+
#
|
435
|
+
# # Create a client object. The client can be reused for multiple calls.
|
436
|
+
# client = Google::Longrunning::Operations::Client.new
|
437
|
+
#
|
438
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
439
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
440
|
+
#
|
441
|
+
# # Call the cancel_operation method.
|
442
|
+
# result = client.cancel_operation request
|
443
|
+
#
|
444
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
445
|
+
# p result
|
446
|
+
#
|
362
447
|
def cancel_operation request, options = nil
|
363
448
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
364
449
|
|
@@ -376,16 +461,20 @@ module Google
|
|
376
461
|
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
377
462
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
378
463
|
|
379
|
-
header_params = {
|
380
|
-
|
381
|
-
|
464
|
+
header_params = {}
|
465
|
+
if request.name
|
466
|
+
header_params["name"] = request.name
|
467
|
+
end
|
468
|
+
|
382
469
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
383
470
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
384
471
|
|
385
472
|
options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
|
386
473
|
metadata: metadata,
|
387
474
|
retry_policy: @config.rpcs.cancel_operation.retry_policy
|
388
|
-
|
475
|
+
|
476
|
+
options.apply_defaults timeout: @config.timeout,
|
477
|
+
metadata: @config.metadata,
|
389
478
|
retry_policy: @config.retry_policy
|
390
479
|
|
391
480
|
@operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
|
@@ -437,6 +526,28 @@ module Google
|
|
437
526
|
#
|
438
527
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
439
528
|
#
|
529
|
+
# @example Basic example
|
530
|
+
# require "google/longrunning"
|
531
|
+
#
|
532
|
+
# # Create a client object. The client can be reused for multiple calls.
|
533
|
+
# client = Google::Longrunning::Operations::Client.new
|
534
|
+
#
|
535
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
536
|
+
# request = Google::Longrunning::WaitOperationRequest.new
|
537
|
+
#
|
538
|
+
# # Call the wait_operation method.
|
539
|
+
# result = client.wait_operation request
|
540
|
+
#
|
541
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
542
|
+
# # object to check the status of an operation, cancel it, or wait
|
543
|
+
# # for results. Here is how to block until completion:
|
544
|
+
# result.wait_until_done! timeout: 60
|
545
|
+
# if result.response?
|
546
|
+
# p result.response
|
547
|
+
# else
|
548
|
+
# puts "Error!"
|
549
|
+
# end
|
550
|
+
#
|
440
551
|
def wait_operation request, options = nil
|
441
552
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
442
553
|
|
@@ -457,7 +568,9 @@ module Google
|
|
457
568
|
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
458
569
|
metadata: metadata,
|
459
570
|
retry_policy: @config.rpcs.wait_operation.retry_policy
|
460
|
-
|
571
|
+
|
572
|
+
options.apply_defaults timeout: @config.timeout,
|
573
|
+
metadata: @config.metadata,
|
461
574
|
retry_policy: @config.retry_policy
|
462
575
|
|
463
576
|
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
@@ -482,22 +595,21 @@ module Google
|
|
482
595
|
# Configuration can be applied globally to all clients, or to a single client
|
483
596
|
# on construction.
|
484
597
|
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
# to 20 seconds,
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
# end
|
598
|
+
# @example
|
599
|
+
#
|
600
|
+
# # Modify the global config, setting the timeout for
|
601
|
+
# # list_operations to 20 seconds,
|
602
|
+
# # and all remaining timeouts to 10 seconds.
|
603
|
+
# ::Google::Longrunning::Operations::Client.configure do |config|
|
604
|
+
# config.timeout = 10.0
|
605
|
+
# config.rpcs.list_operations.timeout = 20.0
|
606
|
+
# end
|
607
|
+
#
|
608
|
+
# # Apply the above configuration only to a new client.
|
609
|
+
# client = ::Google::Longrunning::Operations::Client.new do |config|
|
610
|
+
# config.timeout = 10.0
|
611
|
+
# config.rpcs.list_operations.timeout = 20.0
|
612
|
+
# end
|
501
613
|
#
|
502
614
|
# @!attribute [rw] endpoint
|
503
615
|
# The hostname or hostname:port of the service endpoint.
|
@@ -103,6 +103,20 @@ module Google
|
|
103
103
|
"projects/#{project}/databases/#{database}/collectionGroups/#{collection}/indexes/#{index}"
|
104
104
|
end
|
105
105
|
|
106
|
+
##
|
107
|
+
# Create a fully-qualified Project resource string.
|
108
|
+
#
|
109
|
+
# The resource will be in the following format:
|
110
|
+
#
|
111
|
+
# `projects/{project}`
|
112
|
+
#
|
113
|
+
# @param project [String]
|
114
|
+
#
|
115
|
+
# @return [::String]
|
116
|
+
def project_path project:
|
117
|
+
"projects/#{project}"
|
118
|
+
end
|
119
|
+
|
106
120
|
extend self
|
107
121
|
end
|
108
122
|
end
|
@@ -33,6 +33,32 @@ module Google
|
|
33
33
|
module Admin
|
34
34
|
module V1
|
35
35
|
##
|
36
|
+
# The Cloud Firestore Admin API.
|
37
|
+
#
|
38
|
+
# This API provides several administrative services for Cloud Firestore.
|
39
|
+
#
|
40
|
+
# Project, Database, Namespace, Collection, Collection Group, and Document are
|
41
|
+
# used as defined in the Google Cloud Firestore API.
|
42
|
+
#
|
43
|
+
# Operation: An Operation represents work being performed in the background.
|
44
|
+
#
|
45
|
+
# The index service manages Cloud Firestore indexes.
|
46
|
+
#
|
47
|
+
# Index creation is performed asynchronously.
|
48
|
+
# An Operation resource is created for each such asynchronous operation.
|
49
|
+
# The state of the operation (including any errors encountered)
|
50
|
+
# may be queried via the Operation resource.
|
51
|
+
#
|
52
|
+
# The Operations collection provides a record of actions performed for the
|
53
|
+
# specified Project (including any Operations in progress). Operations are not
|
54
|
+
# created directly but through calls on other collections or resources.
|
55
|
+
#
|
56
|
+
# An Operation that is done may be deleted so that it is no longer listed as
|
57
|
+
# part of the Operation collection. Operations are garbage collected after
|
58
|
+
# 30 days. By default, ListOperations will only return in progress and failed
|
59
|
+
# operations. To list completed operation, issue a ListOperations request with
|
60
|
+
# the filter `done: true`.
|
61
|
+
#
|
36
62
|
# Operations are created by service `FirestoreAdmin`, but are accessed via
|
37
63
|
# service `google.longrunning.Operations`.
|
38
64
|
#
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/firestore/admin/v1/database.proto
|
3
|
+
|
4
|
+
require 'google/api/field_behavior_pb'
|
5
|
+
require 'google/api/resource_pb'
|
6
|
+
require 'google/protobuf/duration_pb'
|
7
|
+
require 'google/protobuf/timestamp_pb'
|
8
|
+
require 'google/api/annotations_pb'
|
9
|
+
require 'google/protobuf'
|
10
|
+
|
11
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
|
+
add_file("google/firestore/admin/v1/database.proto", :syntax => :proto3) do
|
13
|
+
add_message "google.firestore.admin.v1.Database" do
|
14
|
+
optional :name, :string, 1
|
15
|
+
optional :location_id, :string, 9
|
16
|
+
optional :type, :enum, 10, "google.firestore.admin.v1.Database.DatabaseType"
|
17
|
+
optional :concurrency_mode, :enum, 15, "google.firestore.admin.v1.Database.ConcurrencyMode"
|
18
|
+
optional :etag, :string, 99
|
19
|
+
end
|
20
|
+
add_enum "google.firestore.admin.v1.Database.DatabaseType" do
|
21
|
+
value :DATABASE_TYPE_UNSPECIFIED, 0
|
22
|
+
value :FIRESTORE_NATIVE, 1
|
23
|
+
value :DATASTORE_MODE, 2
|
24
|
+
end
|
25
|
+
add_enum "google.firestore.admin.v1.Database.ConcurrencyMode" do
|
26
|
+
value :CONCURRENCY_MODE_UNSPECIFIED, 0
|
27
|
+
value :OPTIMISTIC, 1
|
28
|
+
value :PESSIMISTIC, 2
|
29
|
+
value :OPTIMISTIC_WITH_ENTITY_GROUPS, 3
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
module Google
|
35
|
+
module Cloud
|
36
|
+
module Firestore
|
37
|
+
module Admin
|
38
|
+
module V1
|
39
|
+
Database = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database").msgclass
|
40
|
+
Database::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.DatabaseType").enummodule
|
41
|
+
Database::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.ConcurrencyMode").enummodule
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -1,11 +1,12 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/firestore/admin/v1/field.proto
|
3
3
|
|
4
|
-
require 'google/
|
5
|
-
|
4
|
+
require 'google/api/field_behavior_pb'
|
6
5
|
require 'google/api/resource_pb'
|
7
6
|
require 'google/firestore/admin/v1/index_pb'
|
8
7
|
require 'google/api/annotations_pb'
|
8
|
+
require 'google/protobuf'
|
9
|
+
|
9
10
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
11
|
add_file("google/firestore/admin/v1/field.proto", :syntax => :proto3) do
|
11
12
|
add_message "google.firestore.admin.v1.Field" do
|
@@ -1,19 +1,37 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/firestore/admin/v1/firestore_admin.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
9
7
|
require 'google/api/resource_pb'
|
8
|
+
require 'google/firestore/admin/v1/database_pb'
|
10
9
|
require 'google/firestore/admin/v1/field_pb'
|
11
10
|
require 'google/firestore/admin/v1/index_pb'
|
11
|
+
require 'google/firestore/admin/v1/operation_pb'
|
12
12
|
require 'google/longrunning/operations_pb'
|
13
13
|
require 'google/protobuf/empty_pb'
|
14
14
|
require 'google/protobuf/field_mask_pb'
|
15
|
+
require 'google/protobuf/timestamp_pb'
|
16
|
+
require 'google/protobuf'
|
17
|
+
|
15
18
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
16
19
|
add_file("google/firestore/admin/v1/firestore_admin.proto", :syntax => :proto3) do
|
20
|
+
add_message "google.firestore.admin.v1.ListDatabasesRequest" do
|
21
|
+
optional :parent, :string, 1
|
22
|
+
end
|
23
|
+
add_message "google.firestore.admin.v1.ListDatabasesResponse" do
|
24
|
+
repeated :databases, :message, 1, "google.firestore.admin.v1.Database"
|
25
|
+
end
|
26
|
+
add_message "google.firestore.admin.v1.GetDatabaseRequest" do
|
27
|
+
optional :name, :string, 1
|
28
|
+
end
|
29
|
+
add_message "google.firestore.admin.v1.UpdateDatabaseRequest" do
|
30
|
+
optional :database, :message, 1, "google.firestore.admin.v1.Database"
|
31
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
32
|
+
end
|
33
|
+
add_message "google.firestore.admin.v1.UpdateDatabaseMetadata" do
|
34
|
+
end
|
17
35
|
add_message "google.firestore.admin.v1.CreateIndexRequest" do
|
18
36
|
optional :parent, :string, 1
|
19
37
|
optional :index, :message, 2, "google.firestore.admin.v1.Index"
|
@@ -69,6 +87,11 @@ module Google
|
|
69
87
|
module Firestore
|
70
88
|
module Admin
|
71
89
|
module V1
|
90
|
+
ListDatabasesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListDatabasesRequest").msgclass
|
91
|
+
ListDatabasesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListDatabasesResponse").msgclass
|
92
|
+
GetDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.GetDatabaseRequest").msgclass
|
93
|
+
UpdateDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateDatabaseRequest").msgclass
|
94
|
+
UpdateDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateDatabaseMetadata").msgclass
|
72
95
|
CreateIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.CreateIndexRequest").msgclass
|
73
96
|
ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesRequest").msgclass
|
74
97
|
ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesResponse").msgclass
|
@@ -1,7 +1,7 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# Source: google/firestore/admin/v1/firestore_admin.proto for package 'Google.Cloud.Firestore.Admin.V1'
|
3
3
|
# Original file comments:
|
4
|
-
# Copyright
|
4
|
+
# Copyright 2021 Google LLC
|
5
5
|
#
|
6
6
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
7
|
# you may not use this file except in compliance with the License.
|
@@ -15,7 +15,6 @@
|
|
15
15
|
# See the License for the specific language governing permissions and
|
16
16
|
# limitations under the License.
|
17
17
|
#
|
18
|
-
#
|
19
18
|
|
20
19
|
require 'grpc'
|
21
20
|
require 'google/firestore/admin/v1/firestore_admin_pb'
|
@@ -26,11 +25,37 @@ module Google
|
|
26
25
|
module Admin
|
27
26
|
module V1
|
28
27
|
module FirestoreAdmin
|
28
|
+
# The Cloud Firestore Admin API.
|
29
|
+
#
|
30
|
+
# This API provides several administrative services for Cloud Firestore.
|
31
|
+
#
|
32
|
+
# Project, Database, Namespace, Collection, Collection Group, and Document are
|
33
|
+
# used as defined in the Google Cloud Firestore API.
|
34
|
+
#
|
35
|
+
# Operation: An Operation represents work being performed in the background.
|
36
|
+
#
|
37
|
+
# The index service manages Cloud Firestore indexes.
|
38
|
+
#
|
39
|
+
# Index creation is performed asynchronously.
|
40
|
+
# An Operation resource is created for each such asynchronous operation.
|
41
|
+
# The state of the operation (including any errors encountered)
|
42
|
+
# may be queried via the Operation resource.
|
43
|
+
#
|
44
|
+
# The Operations collection provides a record of actions performed for the
|
45
|
+
# specified Project (including any Operations in progress). Operations are not
|
46
|
+
# created directly but through calls on other collections or resources.
|
47
|
+
#
|
48
|
+
# An Operation that is done may be deleted so that it is no longer listed as
|
49
|
+
# part of the Operation collection. Operations are garbage collected after
|
50
|
+
# 30 days. By default, ListOperations will only return in progress and failed
|
51
|
+
# operations. To list completed operation, issue a ListOperations request with
|
52
|
+
# the filter `done: true`.
|
53
|
+
#
|
29
54
|
# Operations are created by service `FirestoreAdmin`, but are accessed via
|
30
55
|
# service `google.longrunning.Operations`.
|
31
56
|
class Service
|
32
57
|
|
33
|
-
include GRPC::GenericService
|
58
|
+
include ::GRPC::GenericService
|
34
59
|
|
35
60
|
self.marshal_class_method = :encode
|
36
61
|
self.unmarshal_class_method = :decode
|
@@ -67,7 +92,7 @@ module Google
|
|
67
92
|
# Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
|
68
93
|
# that have been explicitly overridden. To issue this query, call
|
69
94
|
# [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
|
70
|
-
# `indexConfig.usesAncestorConfig:false
|
95
|
+
# `indexConfig.usesAncestorConfig:false` .
|
71
96
|
rpc :ListFields, ::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest, ::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse
|
72
97
|
# Exports a copy of all or a subset of documents from Google Cloud Firestore
|
73
98
|
# to another storage system, such as Google Cloud Storage. Recent updates to
|
@@ -77,6 +102,9 @@ module Google
|
|
77
102
|
# used once the associated operation is done. If an export operation is
|
78
103
|
# cancelled before completion it may leave partial data behind in Google
|
79
104
|
# Cloud Storage.
|
105
|
+
#
|
106
|
+
# For more details on export behavior and output format, refer to:
|
107
|
+
# https://cloud.google.com/firestore/docs/manage-data/export-import
|
80
108
|
rpc :ExportDocuments, ::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest, ::Google::Longrunning::Operation
|
81
109
|
# Imports documents into Google Cloud Firestore. Existing documents with the
|
82
110
|
# same name are overwritten. The import occurs in the background and its
|
@@ -84,6 +112,12 @@ module Google
|
|
84
112
|
# created. If an ImportDocuments operation is cancelled, it is possible
|
85
113
|
# that a subset of the data has already been imported to Cloud Firestore.
|
86
114
|
rpc :ImportDocuments, ::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest, ::Google::Longrunning::Operation
|
115
|
+
# Gets information about a database.
|
116
|
+
rpc :GetDatabase, ::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest, ::Google::Cloud::Firestore::Admin::V1::Database
|
117
|
+
# List all the databases in the project.
|
118
|
+
rpc :ListDatabases, ::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest, ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse
|
119
|
+
# Updates a database.
|
120
|
+
rpc :UpdateDatabase, ::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest, ::Google::Longrunning::Operation
|
87
121
|
end
|
88
122
|
|
89
123
|
Stub = Service.rpc_stub_class
|
@@ -1,10 +1,10 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/firestore/admin/v1/index.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/resource_pb'
|
7
5
|
require 'google/api/annotations_pb'
|
6
|
+
require 'google/protobuf'
|
7
|
+
|
8
8
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
9
9
|
add_file("google/firestore/admin/v1/index.proto", :syntax => :proto3) do
|
10
10
|
add_message "google.firestore.admin.v1.Index" do
|
@@ -1,10 +1,10 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/firestore/admin/v1/location.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/type/latlng_pb'
|
7
5
|
require 'google/api/annotations_pb'
|
6
|
+
require 'google/protobuf'
|
7
|
+
|
8
8
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
9
9
|
add_file("google/firestore/admin/v1/location.proto", :syntax => :proto3) do
|
10
10
|
add_message "google.firestore.admin.v1.LocationMetadata" do
|
@@ -1,11 +1,11 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/firestore/admin/v1/operation.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/firestore/admin/v1/index_pb'
|
7
5
|
require 'google/protobuf/timestamp_pb'
|
8
6
|
require 'google/api/annotations_pb'
|
7
|
+
require 'google/protobuf'
|
8
|
+
|
9
9
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
10
|
add_file("google/firestore/admin/v1/operation.proto", :syntax => :proto3) do
|
11
11
|
add_message "google.firestore.admin.v1.IndexOperationMetadata" do
|