google-cloud-firestore-admin-v1 0.10.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +34 -3
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +10 -1
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/client.rb +282 -2
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb +75 -0
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/database_pb.rb +6 -1
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +4 -1
- data/lib/google/firestore/admin/v1/operation_pb.rb +2 -1
- data/proto_docs/google/api/client.rb +13 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/firestore/admin/v1/database.rb +53 -6
- data/proto_docs/google/firestore/admin/v1/firestore_admin.rb +25 -0
- data/proto_docs/google/firestore/admin/v1/location.rb +2 -1
- data/proto_docs/google/firestore/admin/v1/operation.rb +28 -11
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 258717b9ae7319970b1939658cc7b7f68eb3b932983fd71955bdce698eeae519
|
4
|
+
data.tar.gz: e02ed39f218e83fd8b33ca3dacf468c9450ca6e92fc66b5049227bd79b319671
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd9299992ee1b2c2159c8cbd22e999e221355353ca254b440229e57c9aca5bffa3c83dcf176f8ca3772ddb9657deab6aa758acec7dd120d8754f30e018cc4ee8
|
7
|
+
data.tar.gz: ad0055014129be9599e77d2f49bbdc7518da3272b2d9877fc76b2d096737488992a49b07eed3d154f4797c4118b2a2c9de29c25f4330a79dd8e5bf17d4b7e549
|
@@ -212,7 +212,8 @@ module Google
|
|
212
212
|
credentials: credentials,
|
213
213
|
endpoint: @config.endpoint,
|
214
214
|
channel_args: @config.channel_args,
|
215
|
-
interceptors: @config.interceptors
|
215
|
+
interceptors: @config.interceptors,
|
216
|
+
channel_pool_config: @config.channel_pool
|
216
217
|
)
|
217
218
|
end
|
218
219
|
|
@@ -934,7 +935,7 @@ module Google
|
|
934
935
|
# @param options [::Gapic::CallOptions, ::Hash]
|
935
936
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
936
937
|
#
|
937
|
-
# @overload export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil)
|
938
|
+
# @overload export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil, namespace_ids: nil, snapshot_time: nil)
|
938
939
|
# Pass arguments to `export_documents` via keyword arguments. Note that at
|
939
940
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
940
941
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -953,6 +954,21 @@ module Google
|
|
953
954
|
# guidelines: https://cloud.google.com/storage/docs/naming.
|
954
955
|
# If the URI is a bucket (without a namespace path), a prefix will be
|
955
956
|
# generated based on the start time.
|
957
|
+
# @param namespace_ids [::Array<::String>]
|
958
|
+
# Unspecified means all namespaces. This is the preferred
|
959
|
+
# usage for databases that don't use namespaces.
|
960
|
+
#
|
961
|
+
# An empty string element represents the default namespace. This should be
|
962
|
+
# used if the database has data in non-default namespaces, but doesn't want
|
963
|
+
# to include them. Each namespace in this list must be unique.
|
964
|
+
# @param snapshot_time [::Google::Protobuf::Timestamp, ::Hash]
|
965
|
+
# The timestamp that corresponds to the version of the database to be
|
966
|
+
# exported. The timestamp must be in the past, rounded to the minute and not
|
967
|
+
# older than
|
968
|
+
# {::Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time earliestVersionTime}.
|
969
|
+
# If specified, then the exported documents will represent a consistent view
|
970
|
+
# of the database at the provided time. Otherwise, there are no guarantees
|
971
|
+
# about the consistency of the exported documents.
|
956
972
|
#
|
957
973
|
# @yield [response, operation] Access the result along with the RPC operation
|
958
974
|
# @yieldparam response [::Gapic::Operation]
|
@@ -1043,7 +1059,7 @@ module Google
|
|
1043
1059
|
# @param options [::Gapic::CallOptions, ::Hash]
|
1044
1060
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1045
1061
|
#
|
1046
|
-
# @overload import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil)
|
1062
|
+
# @overload import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil, namespace_ids: nil)
|
1047
1063
|
# Pass arguments to `import_documents` via keyword arguments. Note that at
|
1048
1064
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
1049
1065
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -1060,6 +1076,13 @@ module Google
|
|
1060
1076
|
# an export that has completed successfully.
|
1061
1077
|
# See:
|
1062
1078
|
# {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix}.
|
1079
|
+
# @param namespace_ids [::Array<::String>]
|
1080
|
+
# Unspecified means all namespaces. This is the preferred
|
1081
|
+
# usage for databases that don't use namespaces.
|
1082
|
+
#
|
1083
|
+
# An empty string element represents the default namespace. This should be
|
1084
|
+
# used if the database has data in non-default namespaces, but doesn't want
|
1085
|
+
# to include them. Each namespace in this list must be unique.
|
1063
1086
|
#
|
1064
1087
|
# @yield [response, operation] Access the result along with the RPC operation
|
1065
1088
|
# @yieldparam response [::Gapic::Operation]
|
@@ -1620,6 +1643,14 @@ module Google
|
|
1620
1643
|
end
|
1621
1644
|
end
|
1622
1645
|
|
1646
|
+
##
|
1647
|
+
# Configuration for the channel pool
|
1648
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1649
|
+
#
|
1650
|
+
def channel_pool
|
1651
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1652
|
+
end
|
1653
|
+
|
1623
1654
|
##
|
1624
1655
|
# Configuration RPC class for the FirestoreAdmin API.
|
1625
1656
|
#
|
@@ -94,7 +94,8 @@ module Google
|
|
94
94
|
credentials: credentials,
|
95
95
|
endpoint: @config.endpoint,
|
96
96
|
channel_args: @config.channel_args,
|
97
|
-
interceptors: @config.interceptors
|
97
|
+
interceptors: @config.interceptors,
|
98
|
+
channel_pool_config: @config.channel_pool
|
98
99
|
)
|
99
100
|
|
100
101
|
# Used by an LRO wrapper for some methods of this service
|
@@ -702,6 +703,14 @@ module Google
|
|
702
703
|
end
|
703
704
|
end
|
704
705
|
|
706
|
+
##
|
707
|
+
# Configuration for the channel pool
|
708
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
709
|
+
#
|
710
|
+
def channel_pool
|
711
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
712
|
+
end
|
713
|
+
|
705
714
|
##
|
706
715
|
# Configuration RPC class for the Operations API.
|
707
716
|
#
|
@@ -257,6 +257,29 @@ module Google
|
|
257
257
|
# @return [::Gapic::Operation]
|
258
258
|
#
|
259
259
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
260
|
+
#
|
261
|
+
# @example Basic example
|
262
|
+
# require "google/cloud/firestore/admin/v1"
|
263
|
+
#
|
264
|
+
# # Create a client object. The client can be reused for multiple calls.
|
265
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
266
|
+
#
|
267
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
268
|
+
# request = Google::Cloud::Firestore::Admin::V1::CreateIndexRequest.new
|
269
|
+
#
|
270
|
+
# # Call the create_index method.
|
271
|
+
# result = client.create_index request
|
272
|
+
#
|
273
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
274
|
+
# # check the status of an operation, cancel it, or wait for results.
|
275
|
+
# # Here is how to wait for a response.
|
276
|
+
# result.wait_until_done! timeout: 60
|
277
|
+
# if result.response?
|
278
|
+
# p result.response
|
279
|
+
# else
|
280
|
+
# puts "No response received."
|
281
|
+
# end
|
282
|
+
#
|
260
283
|
def create_index request, options = nil
|
261
284
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
262
285
|
|
@@ -329,6 +352,26 @@ module Google
|
|
329
352
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>]
|
330
353
|
#
|
331
354
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
355
|
+
#
|
356
|
+
# @example Basic example
|
357
|
+
# require "google/cloud/firestore/admin/v1"
|
358
|
+
#
|
359
|
+
# # Create a client object. The client can be reused for multiple calls.
|
360
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
361
|
+
#
|
362
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
363
|
+
# request = Google::Cloud::Firestore::Admin::V1::ListIndexesRequest.new
|
364
|
+
#
|
365
|
+
# # Call the list_indexes method.
|
366
|
+
# result = client.list_indexes request
|
367
|
+
#
|
368
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
369
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
370
|
+
# result.each do |item|
|
371
|
+
# # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Index.
|
372
|
+
# p item
|
373
|
+
# end
|
374
|
+
#
|
332
375
|
def list_indexes request, options = nil
|
333
376
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
334
377
|
|
@@ -393,6 +436,22 @@ module Google
|
|
393
436
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index]
|
394
437
|
#
|
395
438
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
439
|
+
#
|
440
|
+
# @example Basic example
|
441
|
+
# require "google/cloud/firestore/admin/v1"
|
442
|
+
#
|
443
|
+
# # Create a client object. The client can be reused for multiple calls.
|
444
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
445
|
+
#
|
446
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
447
|
+
# request = Google::Cloud::Firestore::Admin::V1::GetIndexRequest.new
|
448
|
+
#
|
449
|
+
# # Call the get_index method.
|
450
|
+
# result = client.get_index request
|
451
|
+
#
|
452
|
+
# # The returned object is of type Google::Cloud::Firestore::Admin::V1::Index.
|
453
|
+
# p result
|
454
|
+
#
|
396
455
|
def get_index request, options = nil
|
397
456
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
398
457
|
|
@@ -456,6 +515,22 @@ module Google
|
|
456
515
|
# @return [::Google::Protobuf::Empty]
|
457
516
|
#
|
458
517
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
518
|
+
#
|
519
|
+
# @example Basic example
|
520
|
+
# require "google/cloud/firestore/admin/v1"
|
521
|
+
#
|
522
|
+
# # Create a client object. The client can be reused for multiple calls.
|
523
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
524
|
+
#
|
525
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
526
|
+
# request = Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest.new
|
527
|
+
#
|
528
|
+
# # Call the delete_index method.
|
529
|
+
# result = client.delete_index request
|
530
|
+
#
|
531
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
532
|
+
# p result
|
533
|
+
#
|
459
534
|
def delete_index request, options = nil
|
460
535
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
461
536
|
|
@@ -519,6 +594,22 @@ module Google
|
|
519
594
|
# @return [::Google::Cloud::Firestore::Admin::V1::Field]
|
520
595
|
#
|
521
596
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
597
|
+
#
|
598
|
+
# @example Basic example
|
599
|
+
# require "google/cloud/firestore/admin/v1"
|
600
|
+
#
|
601
|
+
# # Create a client object. The client can be reused for multiple calls.
|
602
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
603
|
+
#
|
604
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
605
|
+
# request = Google::Cloud::Firestore::Admin::V1::GetFieldRequest.new
|
606
|
+
#
|
607
|
+
# # Call the get_field method.
|
608
|
+
# result = client.get_field request
|
609
|
+
#
|
610
|
+
# # The returned object is of type Google::Cloud::Firestore::Admin::V1::Field.
|
611
|
+
# p result
|
612
|
+
#
|
522
613
|
def get_field request, options = nil
|
523
614
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
524
615
|
|
@@ -599,6 +690,29 @@ module Google
|
|
599
690
|
# @return [::Gapic::Operation]
|
600
691
|
#
|
601
692
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
693
|
+
#
|
694
|
+
# @example Basic example
|
695
|
+
# require "google/cloud/firestore/admin/v1"
|
696
|
+
#
|
697
|
+
# # Create a client object. The client can be reused for multiple calls.
|
698
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
699
|
+
#
|
700
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
701
|
+
# request = Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest.new
|
702
|
+
#
|
703
|
+
# # Call the update_field method.
|
704
|
+
# result = client.update_field request
|
705
|
+
#
|
706
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
707
|
+
# # check the status of an operation, cancel it, or wait for results.
|
708
|
+
# # Here is how to wait for a response.
|
709
|
+
# result.wait_until_done! timeout: 60
|
710
|
+
# if result.response?
|
711
|
+
# p result.response
|
712
|
+
# else
|
713
|
+
# puts "No response received."
|
714
|
+
# end
|
715
|
+
#
|
602
716
|
def update_field request, options = nil
|
603
717
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
604
718
|
|
@@ -683,6 +797,26 @@ module Google
|
|
683
797
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>]
|
684
798
|
#
|
685
799
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
800
|
+
#
|
801
|
+
# @example Basic example
|
802
|
+
# require "google/cloud/firestore/admin/v1"
|
803
|
+
#
|
804
|
+
# # Create a client object. The client can be reused for multiple calls.
|
805
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
806
|
+
#
|
807
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
808
|
+
# request = Google::Cloud::Firestore::Admin::V1::ListFieldsRequest.new
|
809
|
+
#
|
810
|
+
# # Call the list_fields method.
|
811
|
+
# result = client.list_fields request
|
812
|
+
#
|
813
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
814
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
815
|
+
# result.each do |item|
|
816
|
+
# # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Field.
|
817
|
+
# p item
|
818
|
+
# end
|
819
|
+
#
|
686
820
|
def list_fields request, options = nil
|
687
821
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
688
822
|
|
@@ -742,7 +876,7 @@ module Google
|
|
742
876
|
# @param options [::Gapic::CallOptions, ::Hash]
|
743
877
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
744
878
|
#
|
745
|
-
# @overload export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil)
|
879
|
+
# @overload export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil, namespace_ids: nil, snapshot_time: nil)
|
746
880
|
# Pass arguments to `export_documents` via keyword arguments. Note that at
|
747
881
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
748
882
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -761,6 +895,21 @@ module Google
|
|
761
895
|
# guidelines: https://cloud.google.com/storage/docs/naming.
|
762
896
|
# If the URI is a bucket (without a namespace path), a prefix will be
|
763
897
|
# generated based on the start time.
|
898
|
+
# @param namespace_ids [::Array<::String>]
|
899
|
+
# Unspecified means all namespaces. This is the preferred
|
900
|
+
# usage for databases that don't use namespaces.
|
901
|
+
#
|
902
|
+
# An empty string element represents the default namespace. This should be
|
903
|
+
# used if the database has data in non-default namespaces, but doesn't want
|
904
|
+
# to include them. Each namespace in this list must be unique.
|
905
|
+
# @param snapshot_time [::Google::Protobuf::Timestamp, ::Hash]
|
906
|
+
# The timestamp that corresponds to the version of the database to be
|
907
|
+
# exported. The timestamp must be in the past, rounded to the minute and not
|
908
|
+
# older than
|
909
|
+
# {::Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time earliestVersionTime}.
|
910
|
+
# If specified, then the exported documents will represent a consistent view
|
911
|
+
# of the database at the provided time. Otherwise, there are no guarantees
|
912
|
+
# about the consistency of the exported documents.
|
764
913
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
765
914
|
# @yieldparam result [::Gapic::Operation]
|
766
915
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -768,6 +917,29 @@ module Google
|
|
768
917
|
# @return [::Gapic::Operation]
|
769
918
|
#
|
770
919
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
920
|
+
#
|
921
|
+
# @example Basic example
|
922
|
+
# require "google/cloud/firestore/admin/v1"
|
923
|
+
#
|
924
|
+
# # Create a client object. The client can be reused for multiple calls.
|
925
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
926
|
+
#
|
927
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
928
|
+
# request = Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest.new
|
929
|
+
#
|
930
|
+
# # Call the export_documents method.
|
931
|
+
# result = client.export_documents request
|
932
|
+
#
|
933
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
934
|
+
# # check the status of an operation, cancel it, or wait for results.
|
935
|
+
# # Here is how to wait for a response.
|
936
|
+
# result.wait_until_done! timeout: 60
|
937
|
+
# if result.response?
|
938
|
+
# p result.response
|
939
|
+
# else
|
940
|
+
# puts "No response received."
|
941
|
+
# end
|
942
|
+
#
|
771
943
|
def export_documents request, options = nil
|
772
944
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
773
945
|
|
@@ -821,7 +993,7 @@ module Google
|
|
821
993
|
# @param options [::Gapic::CallOptions, ::Hash]
|
822
994
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
823
995
|
#
|
824
|
-
# @overload import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil)
|
996
|
+
# @overload import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil, namespace_ids: nil)
|
825
997
|
# Pass arguments to `import_documents` via keyword arguments. Note that at
|
826
998
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
827
999
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -838,6 +1010,13 @@ module Google
|
|
838
1010
|
# an export that has completed successfully.
|
839
1011
|
# See:
|
840
1012
|
# {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix}.
|
1013
|
+
# @param namespace_ids [::Array<::String>]
|
1014
|
+
# Unspecified means all namespaces. This is the preferred
|
1015
|
+
# usage for databases that don't use namespaces.
|
1016
|
+
#
|
1017
|
+
# An empty string element represents the default namespace. This should be
|
1018
|
+
# used if the database has data in non-default namespaces, but doesn't want
|
1019
|
+
# to include them. Each namespace in this list must be unique.
|
841
1020
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
842
1021
|
# @yieldparam result [::Gapic::Operation]
|
843
1022
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -845,6 +1024,29 @@ module Google
|
|
845
1024
|
# @return [::Gapic::Operation]
|
846
1025
|
#
|
847
1026
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1027
|
+
#
|
1028
|
+
# @example Basic example
|
1029
|
+
# require "google/cloud/firestore/admin/v1"
|
1030
|
+
#
|
1031
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1032
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
1033
|
+
#
|
1034
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1035
|
+
# request = Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest.new
|
1036
|
+
#
|
1037
|
+
# # Call the import_documents method.
|
1038
|
+
# result = client.import_documents request
|
1039
|
+
#
|
1040
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1041
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1042
|
+
# # Here is how to wait for a response.
|
1043
|
+
# result.wait_until_done! timeout: 60
|
1044
|
+
# if result.response?
|
1045
|
+
# p result.response
|
1046
|
+
# else
|
1047
|
+
# puts "No response received."
|
1048
|
+
# end
|
1049
|
+
#
|
848
1050
|
def import_documents request, options = nil
|
849
1051
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
850
1052
|
|
@@ -916,6 +1118,29 @@ module Google
|
|
916
1118
|
# @return [::Gapic::Operation]
|
917
1119
|
#
|
918
1120
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1121
|
+
#
|
1122
|
+
# @example Basic example
|
1123
|
+
# require "google/cloud/firestore/admin/v1"
|
1124
|
+
#
|
1125
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1126
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
1127
|
+
#
|
1128
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1129
|
+
# request = Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest.new
|
1130
|
+
#
|
1131
|
+
# # Call the create_database method.
|
1132
|
+
# result = client.create_database request
|
1133
|
+
#
|
1134
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1135
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1136
|
+
# # Here is how to wait for a response.
|
1137
|
+
# result.wait_until_done! timeout: 60
|
1138
|
+
# if result.response?
|
1139
|
+
# p result.response
|
1140
|
+
# else
|
1141
|
+
# puts "No response received."
|
1142
|
+
# end
|
1143
|
+
#
|
919
1144
|
def create_database request, options = nil
|
920
1145
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
921
1146
|
|
@@ -980,6 +1205,22 @@ module Google
|
|
980
1205
|
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
|
981
1206
|
#
|
982
1207
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1208
|
+
#
|
1209
|
+
# @example Basic example
|
1210
|
+
# require "google/cloud/firestore/admin/v1"
|
1211
|
+
#
|
1212
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1213
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
1214
|
+
#
|
1215
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1216
|
+
# request = Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest.new
|
1217
|
+
#
|
1218
|
+
# # Call the get_database method.
|
1219
|
+
# result = client.get_database request
|
1220
|
+
#
|
1221
|
+
# # The returned object is of type Google::Cloud::Firestore::Admin::V1::Database.
|
1222
|
+
# p result
|
1223
|
+
#
|
983
1224
|
def get_database request, options = nil
|
984
1225
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
985
1226
|
|
@@ -1043,6 +1284,22 @@ module Google
|
|
1043
1284
|
# @return [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
|
1044
1285
|
#
|
1045
1286
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1287
|
+
#
|
1288
|
+
# @example Basic example
|
1289
|
+
# require "google/cloud/firestore/admin/v1"
|
1290
|
+
#
|
1291
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1292
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
1293
|
+
#
|
1294
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1295
|
+
# request = Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest.new
|
1296
|
+
#
|
1297
|
+
# # Call the list_databases method.
|
1298
|
+
# result = client.list_databases request
|
1299
|
+
#
|
1300
|
+
# # The returned object is of type Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse.
|
1301
|
+
# p result
|
1302
|
+
#
|
1046
1303
|
def list_databases request, options = nil
|
1047
1304
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1048
1305
|
|
@@ -1107,6 +1364,29 @@ module Google
|
|
1107
1364
|
# @return [::Gapic::Operation]
|
1108
1365
|
#
|
1109
1366
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1367
|
+
#
|
1368
|
+
# @example Basic example
|
1369
|
+
# require "google/cloud/firestore/admin/v1"
|
1370
|
+
#
|
1371
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1372
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
|
1373
|
+
#
|
1374
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1375
|
+
# request = Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest.new
|
1376
|
+
#
|
1377
|
+
# # Call the update_database method.
|
1378
|
+
# result = client.update_database request
|
1379
|
+
#
|
1380
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1381
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1382
|
+
# # Here is how to wait for a response.
|
1383
|
+
# result.wait_until_done! timeout: 60
|
1384
|
+
# if result.response?
|
1385
|
+
# p result.response
|
1386
|
+
# else
|
1387
|
+
# puts "No response received."
|
1388
|
+
# end
|
1389
|
+
#
|
1110
1390
|
def update_database request, options = nil
|
1111
1391
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1112
1392
|
|
@@ -137,6 +137,26 @@ module Google
|
|
137
137
|
# @return [::Gapic::Operation]
|
138
138
|
#
|
139
139
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
140
|
+
#
|
141
|
+
# @example Basic example
|
142
|
+
# require "google/longrunning"
|
143
|
+
#
|
144
|
+
# # Create a client object. The client can be reused for multiple calls.
|
145
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
146
|
+
#
|
147
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
148
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
149
|
+
#
|
150
|
+
# # Call the list_operations method.
|
151
|
+
# result = client.list_operations request
|
152
|
+
#
|
153
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
154
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
155
|
+
# result.each do |item|
|
156
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
157
|
+
# p item
|
158
|
+
# end
|
159
|
+
#
|
140
160
|
def list_operations request, options = nil
|
141
161
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
142
162
|
|
@@ -202,6 +222,29 @@ module Google
|
|
202
222
|
# @return [::Gapic::Operation]
|
203
223
|
#
|
204
224
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
225
|
+
#
|
226
|
+
# @example Basic example
|
227
|
+
# require "google/longrunning"
|
228
|
+
#
|
229
|
+
# # Create a client object. The client can be reused for multiple calls.
|
230
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
231
|
+
#
|
232
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
233
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
234
|
+
#
|
235
|
+
# # Call the get_operation method.
|
236
|
+
# result = client.get_operation request
|
237
|
+
#
|
238
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
239
|
+
# # check the status of an operation, cancel it, or wait for results.
|
240
|
+
# # Here is how to wait for a response.
|
241
|
+
# result.wait_until_done! timeout: 60
|
242
|
+
# if result.response?
|
243
|
+
# p result.response
|
244
|
+
# else
|
245
|
+
# puts "No response received."
|
246
|
+
# end
|
247
|
+
#
|
205
248
|
def get_operation request, options = nil
|
206
249
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
207
250
|
|
@@ -268,6 +311,22 @@ module Google
|
|
268
311
|
# @return [::Google::Protobuf::Empty]
|
269
312
|
#
|
270
313
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
314
|
+
#
|
315
|
+
# @example Basic example
|
316
|
+
# require "google/longrunning"
|
317
|
+
#
|
318
|
+
# # Create a client object. The client can be reused for multiple calls.
|
319
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
320
|
+
#
|
321
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
322
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
323
|
+
#
|
324
|
+
# # Call the delete_operation method.
|
325
|
+
# result = client.delete_operation request
|
326
|
+
#
|
327
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
328
|
+
# p result
|
329
|
+
#
|
271
330
|
def delete_operation request, options = nil
|
272
331
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
273
332
|
|
@@ -339,6 +398,22 @@ module Google
|
|
339
398
|
# @return [::Google::Protobuf::Empty]
|
340
399
|
#
|
341
400
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
401
|
+
#
|
402
|
+
# @example Basic example
|
403
|
+
# require "google/longrunning"
|
404
|
+
#
|
405
|
+
# # Create a client object. The client can be reused for multiple calls.
|
406
|
+
# client = Google::Longrunning::Operations::Rest::Client.new
|
407
|
+
#
|
408
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
409
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
410
|
+
#
|
411
|
+
# # Call the cancel_operation method.
|
412
|
+
# result = client.cancel_operation request
|
413
|
+
#
|
414
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
415
|
+
# p result
|
416
|
+
#
|
342
417
|
def cancel_operation request, options = nil
|
343
418
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
344
419
|
|
@@ -6,9 +6,11 @@ require 'google/protobuf'
|
|
6
6
|
|
7
7
|
require 'google/api/field_behavior_pb'
|
8
8
|
require 'google/api/resource_pb'
|
9
|
+
require 'google/protobuf/duration_pb'
|
10
|
+
require 'google/protobuf/timestamp_pb'
|
9
11
|
|
10
12
|
|
11
|
-
descriptor_data = "\n(google/firestore/admin/v1/database.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\
|
13
|
+
descriptor_data = "\n(google/firestore/admin/v1/database.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xde\x08\n\x08\x44\x61tabase\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0blocation_id\x18\t \x01(\t\x12>\n\x04type\x18\n \x01(\x0e\x32\x30.google.firestore.admin.v1.Database.DatabaseType\x12M\n\x10\x63oncurrency_mode\x18\x0f \x01(\x0e\x32\x33.google.firestore.admin.v1.Database.ConcurrencyMode\x12@\n\x18version_retention_period\x18\x11 \x01(\x0b\x32\x19.google.protobuf.DurationB\x03\xe0\x41\x03\x12>\n\x15\x65\x61rliest_version_time\x18\x12 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12l\n!point_in_time_recovery_enablement\x18\x15 \x01(\x0e\x32\x41.google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement\x12\x61\n\x1b\x61pp_engine_integration_mode\x18\x13 \x01(\x0e\x32<.google.firestore.admin.v1.Database.AppEngineIntegrationMode\x12\x17\n\nkey_prefix\x18\x14 \x01(\tB\x03\xe0\x41\x03\x12\x0c\n\x04\x65tag\x18\x63 \x01(\t\"W\n\x0c\x44\x61tabaseType\x12\x1d\n\x19\x44\x41TABASE_TYPE_UNSPECIFIED\x10\x00\x12\x14\n\x10\x46IRESTORE_NATIVE\x10\x01\x12\x12\n\x0e\x44\x41TASTORE_MODE\x10\x02\"w\n\x0f\x43oncurrencyMode\x12 \n\x1c\x43ONCURRENCY_MODE_UNSPECIFIED\x10\x00\x12\x0e\n\nOPTIMISTIC\x10\x01\x12\x0f\n\x0bPESSIMISTIC\x10\x02\x12!\n\x1dOPTIMISTIC_WITH_ENTITY_GROUPS\x10\x03\"\x9b\x01\n\x1dPointInTimeRecoveryEnablement\x12\x31\n-POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED\x10\x00\x12\"\n\x1ePOINT_IN_TIME_RECOVERY_ENABLED\x10\x01\x12#\n\x1fPOINT_IN_TIME_RECOVERY_DISABLED\x10\x02\"b\n\x18\x41ppEngineIntegrationMode\x12+\n\'APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\x0c\n\x08\x44ISABLED\x10\x02:R\xea\x41O\n!firestore.googleapis.com/Database\x12\'projects/{project}/databases/{database}R\x01\x01\x42\xdc\x01\n\x1d\x63om.google.firestore.admin.v1B\rDatabaseProtoP\x01Z9cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb\xa2\x02\x04GCFS\xaa\x02\x1fGoogle.Cloud.Firestore.Admin.V1\xca\x02\x1fGoogle\\Cloud\\Firestore\\Admin\\V1\xea\x02#Google::Cloud::Firestore::Admin::V1b\x06proto3"
|
12
14
|
|
13
15
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
14
16
|
|
@@ -23,6 +25,8 @@ rescue TypeError => e
|
|
23
25
|
file = pool.add_serialized_file(serialized)
|
24
26
|
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
25
27
|
imports = [
|
28
|
+
["google.protobuf.Duration", "google/protobuf/duration.proto"],
|
29
|
+
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
26
30
|
]
|
27
31
|
imports.each do |type_name, expected_filename|
|
28
32
|
import_file = pool.lookup(type_name).file_descriptor
|
@@ -42,6 +46,7 @@ module Google
|
|
42
46
|
Database = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database").msgclass
|
43
47
|
Database::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.DatabaseType").enummodule
|
44
48
|
Database::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.ConcurrencyMode").enummodule
|
49
|
+
Database::PointInTimeRecoveryEnablement = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement").enummodule
|
45
50
|
Database::AppEngineIntegrationMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.AppEngineIntegrationMode").enummodule
|
46
51
|
end
|
47
52
|
end
|
@@ -11,12 +11,14 @@ require 'google/api/resource_pb'
|
|
11
11
|
require 'google/firestore/admin/v1/database_pb'
|
12
12
|
require 'google/firestore/admin/v1/field_pb'
|
13
13
|
require 'google/firestore/admin/v1/index_pb'
|
14
|
+
require 'google/firestore/admin/v1/operation_pb'
|
14
15
|
require 'google/longrunning/operations_pb'
|
15
16
|
require 'google/protobuf/empty_pb'
|
16
17
|
require 'google/protobuf/field_mask_pb'
|
18
|
+
require 'google/protobuf/timestamp_pb'
|
17
19
|
|
18
20
|
|
19
|
-
descriptor_data = "\n/google/firestore/admin/v1/firestore_admin.proto\x12\x19google.firestore.admin.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a(google/firestore/admin/v1/database.proto\x1a%google/firestore/admin/v1/field.proto\x1a%google/firestore/admin/v1/index.proto\x1a#google/longrunning/operations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"Q\n\x14ListDatabasesRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\x12!firestore.googleapis.com/Database\"\xa8\x01\n\x15\x43reateDatabaseRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\x12!firestore.googleapis.com/Database\x12:\n\x08\x64\x61tabase\x18\x02 \x01(\x0b\x32#.google.firestore.admin.v1.DatabaseB\x03\xe0\x41\x02\x12\x18\n\x0b\x64\x61tabase_id\x18\x03 \x01(\tB\x03\xe0\x41\x02\"\x18\n\x16\x43reateDatabaseMetadata\"O\n\x15ListDatabasesResponse\x12\x36\n\tdatabases\x18\x01 \x03(\x0b\x32#.google.firestore.admin.v1.Database\"M\n\x12GetDatabaseRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!firestore.googleapis.com/Database\"\x84\x01\n\x15UpdateDatabaseRequest\x12:\n\x08\x64\x61tabase\x18\x01 \x01(\x0b\x32#.google.firestore.admin.v1.DatabaseB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"\x18\n\x16UpdateDatabaseMetadata\"\x8c\x01\n\x12\x43reateIndexRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(firestore.googleapis.com/CollectionGroup\x12\x34\n\x05index\x18\x02 \x01(\x0b\x32 .google.firestore.admin.v1.IndexB\x03\xe0\x41\x02\"\x8d\x01\n\x12ListIndexesRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(firestore.googleapis.com/CollectionGroup\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12\x12\n\npage_token\x18\x04 \x01(\t\"a\n\x13ListIndexesResponse\x12\x31\n\x07indexes\x18\x01 \x03(\x0b\x32 .google.firestore.admin.v1.Index\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"G\n\x0fGetIndexRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x66irestore.googleapis.com/Index\"J\n\x12\x44\x65leteIndexRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x66irestore.googleapis.com/Index\"{\n\x12UpdateFieldRequest\x12\x34\n\x05\x66ield\x18\x01 \x01(\x0b\x32 .google.firestore.admin.v1.FieldB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"G\n\x0fGetFieldRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x66irestore.googleapis.com/Field\"\x8c\x01\n\x11ListFieldsRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(firestore.googleapis.com/CollectionGroup\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12\x12\n\npage_token\x18\x04 \x01(\t\"_\n\x12ListFieldsResponse\x12\x30\n\x06\x66ields\x18\x01 \x03(\x0b\x32 .google.firestore.admin.v1.Field\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\
|
21
|
+
descriptor_data = "\n/google/firestore/admin/v1/firestore_admin.proto\x12\x19google.firestore.admin.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a(google/firestore/admin/v1/database.proto\x1a%google/firestore/admin/v1/field.proto\x1a%google/firestore/admin/v1/index.proto\x1a)google/firestore/admin/v1/operation.proto\x1a#google/longrunning/operations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"Q\n\x14ListDatabasesRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\x12!firestore.googleapis.com/Database\"\xa8\x01\n\x15\x43reateDatabaseRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\x12!firestore.googleapis.com/Database\x12:\n\x08\x64\x61tabase\x18\x02 \x01(\x0b\x32#.google.firestore.admin.v1.DatabaseB\x03\xe0\x41\x02\x12\x18\n\x0b\x64\x61tabase_id\x18\x03 \x01(\tB\x03\xe0\x41\x02\"\x18\n\x16\x43reateDatabaseMetadata\"O\n\x15ListDatabasesResponse\x12\x36\n\tdatabases\x18\x01 \x03(\x0b\x32#.google.firestore.admin.v1.Database\"M\n\x12GetDatabaseRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!firestore.googleapis.com/Database\"\x84\x01\n\x15UpdateDatabaseRequest\x12:\n\x08\x64\x61tabase\x18\x01 \x01(\x0b\x32#.google.firestore.admin.v1.DatabaseB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"\x18\n\x16UpdateDatabaseMetadata\"\x8c\x01\n\x12\x43reateIndexRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(firestore.googleapis.com/CollectionGroup\x12\x34\n\x05index\x18\x02 \x01(\x0b\x32 .google.firestore.admin.v1.IndexB\x03\xe0\x41\x02\"\x8d\x01\n\x12ListIndexesRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(firestore.googleapis.com/CollectionGroup\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12\x12\n\npage_token\x18\x04 \x01(\t\"a\n\x13ListIndexesResponse\x12\x31\n\x07indexes\x18\x01 \x03(\x0b\x32 .google.firestore.admin.v1.Index\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"G\n\x0fGetIndexRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x66irestore.googleapis.com/Index\"J\n\x12\x44\x65leteIndexRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x66irestore.googleapis.com/Index\"{\n\x12UpdateFieldRequest\x12\x34\n\x05\x66ield\x18\x01 \x01(\x0b\x32 .google.firestore.admin.v1.FieldB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"G\n\x0fGetFieldRequest\x12\x34\n\x04name\x18\x01 \x01(\tB&\xe0\x41\x02\xfa\x41 \n\x1e\x66irestore.googleapis.com/Field\"\x8c\x01\n\x11ListFieldsRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(firestore.googleapis.com/CollectionGroup\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12\x12\n\npage_token\x18\x04 \x01(\t\"_\n\x12ListFieldsResponse\x12\x30\n\x06\x66ields\x18\x01 \x03(\x0b\x32 .google.firestore.admin.v1.Field\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\xce\x01\n\x16\x45xportDocumentsRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!firestore.googleapis.com/Database\x12\x16\n\x0e\x63ollection_ids\x18\x02 \x03(\t\x12\x19\n\x11output_uri_prefix\x18\x03 \x01(\t\x12\x15\n\rnamespace_ids\x18\x04 \x03(\t\x12\x31\n\rsnapshot_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\x9a\x01\n\x16ImportDocumentsRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!firestore.googleapis.com/Database\x12\x16\n\x0e\x63ollection_ids\x18\x02 \x03(\t\x12\x18\n\x10input_uri_prefix\x18\x03 \x01(\t\x12\x15\n\rnamespace_ids\x18\x04 \x03(\t2\xee\x14\n\x0e\x46irestoreAdmin\x12\xdb\x01\n\x0b\x43reateIndex\x12-.google.firestore.admin.v1.CreateIndexRequest\x1a\x1d.google.longrunning.Operation\"~\x82\xd3\xe4\x93\x02G\">/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes:\x05index\xda\x41\x0cparent,index\xca\x41\x1f\n\x05Index\x12\x16IndexOperationMetadata\x12\xbd\x01\n\x0bListIndexes\x12-.google.firestore.admin.v1.ListIndexesRequest\x1a..google.firestore.admin.v1.ListIndexesResponse\"O\x82\xd3\xe4\x93\x02@\x12>/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes\xda\x41\x06parent\x12\xa7\x01\n\x08GetIndex\x12*.google.firestore.admin.v1.GetIndexRequest\x1a .google.firestore.admin.v1.Index\"M\x82\xd3\xe4\x93\x02@\x12>/v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}\xda\x41\x04name\x12\xa3\x01\n\x0b\x44\x65leteIndex\x12-.google.firestore.admin.v1.DeleteIndexRequest\x1a\x16.google.protobuf.Empty\"M\x82\xd3\xe4\x93\x02@*>/v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}\xda\x41\x04name\x12\xa6\x01\n\x08GetField\x12*.google.firestore.admin.v1.GetFieldRequest\x1a .google.firestore.admin.v1.Field\"L\x82\xd3\xe4\x93\x02?\x12=/v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}\xda\x41\x04name\x12\xd9\x01\n\x0bUpdateField\x12-.google.firestore.admin.v1.UpdateFieldRequest\x1a\x1d.google.longrunning.Operation\"|\x82\xd3\xe4\x93\x02L2C/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}:\x05\x66ield\xda\x41\x05\x66ield\xca\x41\x1f\n\x05\x46ield\x12\x16\x46ieldOperationMetadata\x12\xb9\x01\n\nListFields\x12,.google.firestore.admin.v1.ListFieldsRequest\x1a-.google.firestore.admin.v1.ListFieldsResponse\"N\x82\xd3\xe4\x93\x02?\x12=/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields\xda\x41\x06parent\x12\xdd\x01\n\x0f\x45xportDocuments\x12\x31.google.firestore.admin.v1.ExportDocumentsRequest\x1a\x1d.google.longrunning.Operation\"x\x82\xd3\xe4\x93\x02\x36\"1/v1/{name=projects/*/databases/*}:exportDocuments:\x01*\xda\x41\x04name\xca\x41\x32\n\x17\x45xportDocumentsResponse\x12\x17\x45xportDocumentsMetadata\x12\xdb\x01\n\x0fImportDocuments\x12\x31.google.firestore.admin.v1.ImportDocumentsRequest\x1a\x1d.google.longrunning.Operation\"v\x82\xd3\xe4\x93\x02\x36\"1/v1/{name=projects/*/databases/*}:importDocuments:\x01*\xda\x41\x04name\xca\x41\x30\n\x15google.protobuf.Empty\x12\x17ImportDocumentsMetadata\x12\xd9\x01\n\x0e\x43reateDatabase\x12\x30.google.firestore.admin.v1.CreateDatabaseRequest\x1a\x1d.google.longrunning.Operation\"v\x82\xd3\xe4\x93\x02-\"!/v1/{parent=projects/*}/databases:\x08\x64\x61tabase\xda\x41\x1bparent,database,database_id\xca\x41\"\n\x08\x44\x61tabase\x12\x16\x43reateDatabaseMetadata\x12\x93\x01\n\x0bGetDatabase\x12-.google.firestore.admin.v1.GetDatabaseRequest\x1a#.google.firestore.admin.v1.Database\"0\x82\xd3\xe4\x93\x02#\x12!/v1/{name=projects/*/databases/*}\xda\x41\x04name\x12\xa6\x01\n\rListDatabases\x12/.google.firestore.admin.v1.ListDatabasesRequest\x1a\x30.google.firestore.admin.v1.ListDatabasesResponse\"2\x82\xd3\xe4\x93\x02#\x12!/v1/{parent=projects/*}/databases\xda\x41\x06parent\x12\xdb\x01\n\x0eUpdateDatabase\x12\x30.google.firestore.admin.v1.UpdateDatabaseRequest\x1a\x1d.google.longrunning.Operation\"x\x82\xd3\xe4\x93\x02\x36\x32*/v1/{database.name=projects/*/databases/*}:\x08\x64\x61tabase\xda\x41\x14\x64\x61tabase,update_mask\xca\x41\"\n\x08\x44\x61tabase\x12\x16UpdateDatabaseMetadata\x1av\xca\x41\x18\x66irestore.googleapis.com\xd2\x41Xhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/datastoreB\xa5\x03\n\x1d\x63om.google.firestore.admin.v1B\x13\x46irestoreAdminProtoP\x01Z9cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb\xa2\x02\x04GCFS\xaa\x02\x1fGoogle.Cloud.Firestore.Admin.V1\xca\x02\x1fGoogle\\Cloud\\Firestore\\Admin\\V1\xea\x02#Google::Cloud::Firestore::Admin::V1\xea\x41L\n!firestore.googleapis.com/Location\x12\'projects/{project}/locations/{location}\xea\x41q\n(firestore.googleapis.com/CollectionGroup\x12\x45projects/{project}/databases/{database}/collectionGroups/{collection}b\x06proto3"
|
20
22
|
|
21
23
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
22
24
|
|
@@ -35,6 +37,7 @@ rescue TypeError => e
|
|
35
37
|
["google.protobuf.FieldMask", "google/protobuf/field_mask.proto"],
|
36
38
|
["google.firestore.admin.v1.Index", "google/firestore/admin/v1/index.proto"],
|
37
39
|
["google.firestore.admin.v1.Field", "google/firestore/admin/v1/field.proto"],
|
40
|
+
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
38
41
|
]
|
39
42
|
imports.each do |type_name, expected_filename|
|
40
43
|
import_file = pool.lookup(type_name).file_descriptor
|
@@ -4,11 +4,12 @@
|
|
4
4
|
|
5
5
|
require 'google/protobuf'
|
6
6
|
|
7
|
+
require 'google/api/resource_pb'
|
7
8
|
require 'google/firestore/admin/v1/index_pb'
|
8
9
|
require 'google/protobuf/timestamp_pb'
|
9
10
|
|
10
11
|
|
11
|
-
descriptor_data = "\n)google/firestore/admin/v1/operation.proto\x12\x19google.firestore.admin.v1\x1a%google/firestore/admin/v1/index.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xbd\x02\n\x16IndexOperationMetadata\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\r\n\x05index\x18\x03 \x01(\t\x12\x38\n\x05state\x18\x04 \x01(\x0e\x32).google.firestore.admin.v1.OperationState\x12?\n\x12progress_documents\x18\x05 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12;\n\x0eprogress_bytes\x18\x06 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\"\x99\x07\n\x16\x46ieldOperationMetadata\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\r\n\x05\x66ield\x18\x03 \x01(\t\x12_\n\x13index_config_deltas\x18\x04 \x03(\x0b\x32\x42.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta\x12\x38\n\x05state\x18\x05 \x01(\x0e\x32).google.firestore.admin.v1.OperationState\x12?\n\x12progress_documents\x18\x06 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12;\n\x0eprogress_bytes\x18\x07 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12Z\n\x10ttl_config_delta\x18\x08 \x01(\x0b\x32@.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta\x1a\xe7\x01\n\x10IndexConfigDelta\x12\x62\n\x0b\x63hange_type\x18\x01 \x01(\x0e\x32M.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType\x12/\n\x05index\x18\x02 \x01(\x0b\x32 .google.firestore.admin.v1.Index\">\n\nChangeType\x12\x1b\n\x17\x43HANGE_TYPE_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41\x44\x44\x10\x01\x12\n\n\x06REMOVE\x10\x02\x1a\xb2\x01\n\x0eTtlConfigDelta\x12`\n\x0b\x63hange_type\x18\x01 \x01(\x0e\x32K.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType\">\n\nChangeType\x12\x1b\n\x17\x43HANGE_TYPE_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41\x44\x44\x10\x01\x12\n\n\x06REMOVE\x10\x02\"\
|
12
|
+
descriptor_data = "\n)google/firestore/admin/v1/operation.proto\x12\x19google.firestore.admin.v1\x1a\x19google/api/resource.proto\x1a%google/firestore/admin/v1/index.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xbd\x02\n\x16IndexOperationMetadata\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\r\n\x05index\x18\x03 \x01(\t\x12\x38\n\x05state\x18\x04 \x01(\x0e\x32).google.firestore.admin.v1.OperationState\x12?\n\x12progress_documents\x18\x05 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12;\n\x0eprogress_bytes\x18\x06 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\"\x99\x07\n\x16\x46ieldOperationMetadata\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\r\n\x05\x66ield\x18\x03 \x01(\t\x12_\n\x13index_config_deltas\x18\x04 \x03(\x0b\x32\x42.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta\x12\x38\n\x05state\x18\x05 \x01(\x0e\x32).google.firestore.admin.v1.OperationState\x12?\n\x12progress_documents\x18\x06 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12;\n\x0eprogress_bytes\x18\x07 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12Z\n\x10ttl_config_delta\x18\x08 \x01(\x0b\x32@.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta\x1a\xe7\x01\n\x10IndexConfigDelta\x12\x62\n\x0b\x63hange_type\x18\x01 \x01(\x0e\x32M.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType\x12/\n\x05index\x18\x02 \x01(\x0b\x32 .google.firestore.admin.v1.Index\">\n\nChangeType\x12\x1b\n\x17\x43HANGE_TYPE_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41\x44\x44\x10\x01\x12\n\n\x06REMOVE\x10\x02\x1a\xb2\x01\n\x0eTtlConfigDelta\x12`\n\x0b\x63hange_type\x18\x01 \x01(\x0e\x32K.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType\">\n\nChangeType\x12\x1b\n\x17\x43HANGE_TYPE_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41\x44\x44\x10\x01\x12\n\n\x06REMOVE\x10\x02\"\xb6\x03\n\x17\x45xportDocumentsMetadata\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x42\n\x0foperation_state\x18\x03 \x01(\x0e\x32).google.firestore.admin.v1.OperationState\x12?\n\x12progress_documents\x18\x04 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12;\n\x0eprogress_bytes\x18\x05 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12\x16\n\x0e\x63ollection_ids\x18\x06 \x03(\t\x12\x19\n\x11output_uri_prefix\x18\x07 \x01(\t\x12\x15\n\rnamespace_ids\x18\x08 \x03(\t\x12\x31\n\rsnapshot_time\x18\t \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\x82\x03\n\x17ImportDocumentsMetadata\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x42\n\x0foperation_state\x18\x03 \x01(\x0e\x32).google.firestore.admin.v1.OperationState\x12?\n\x12progress_documents\x18\x04 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12;\n\x0eprogress_bytes\x18\x05 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\x12\x16\n\x0e\x63ollection_ids\x18\x06 \x03(\t\x12\x18\n\x10input_uri_prefix\x18\x07 \x01(\t\x12\x15\n\rnamespace_ids\x18\x08 \x03(\t\"4\n\x17\x45xportDocumentsResponse\x12\x19\n\x11output_uri_prefix\x18\x01 \x01(\t\":\n\x08Progress\x12\x16\n\x0e\x65stimated_work\x18\x01 \x01(\x03\x12\x16\n\x0e\x63ompleted_work\x18\x02 \x01(\x03*\x9e\x01\n\x0eOperationState\x12\x1f\n\x1bOPERATION_STATE_UNSPECIFIED\x10\x00\x12\x10\n\x0cINITIALIZING\x10\x01\x12\x0e\n\nPROCESSING\x10\x02\x12\x0e\n\nCANCELLING\x10\x03\x12\x0e\n\nFINALIZING\x10\x04\x12\x0e\n\nSUCCESSFUL\x10\x05\x12\n\n\x06\x46\x41ILED\x10\x06\x12\r\n\tCANCELLED\x10\x07\x42\xdd\x01\n\x1d\x63om.google.firestore.admin.v1B\x0eOperationProtoP\x01Z9cloud.google.com/go/firestore/apiv1/admin/adminpb;adminpb\xa2\x02\x04GCFS\xaa\x02\x1fGoogle.Cloud.Firestore.Admin.V1\xca\x02\x1fGoogle\\Cloud\\Firestore\\Admin\\V1\xea\x02#Google::Cloud::Firestore::Admin::V1b\x06proto3"
|
12
13
|
|
13
14
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
14
15
|
|
@@ -304,6 +304,19 @@ module Google
|
|
304
304
|
# seconds: 360 # 6 minutes
|
305
305
|
# total_poll_timeout:
|
306
306
|
# seconds: 54000 # 90 minutes
|
307
|
+
# @!attribute [rw] auto_populated_fields
|
308
|
+
# @return [::Array<::String>]
|
309
|
+
# List of top-level fields of the request message, that should be
|
310
|
+
# automatically populated by the client libraries based on their
|
311
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
312
|
+
#
|
313
|
+
# Example of a YAML configuration:
|
314
|
+
#
|
315
|
+
# publishing:
|
316
|
+
# method_settings:
|
317
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
318
|
+
# auto_populated_fields:
|
319
|
+
# - request_id
|
307
320
|
class MethodSettings
|
308
321
|
include ::Google::Protobuf::MessageExts
|
309
322
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
@@ -31,7 +31,7 @@ module Google
|
|
31
31
|
# Format: `projects/{project}/databases/{database}`
|
32
32
|
# @!attribute [rw] location_id
|
33
33
|
# @return [::String]
|
34
|
-
# The location of the database. Available
|
34
|
+
# The location of the database. Available locations are listed at
|
35
35
|
# https://cloud.google.com/firestore/docs/locations.
|
36
36
|
# @!attribute [rw] type
|
37
37
|
# @return [::Google::Cloud::Firestore::Admin::V1::Database::DatabaseType]
|
@@ -41,15 +41,40 @@ module Google
|
|
41
41
|
# @!attribute [rw] concurrency_mode
|
42
42
|
# @return [::Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode]
|
43
43
|
# The concurrency control mode to use for this database.
|
44
|
+
# @!attribute [r] version_retention_period
|
45
|
+
# @return [::Google::Protobuf::Duration]
|
46
|
+
# Output only. The period during which past versions of data are retained in
|
47
|
+
# the database.
|
48
|
+
#
|
49
|
+
# Any [read][google.firestore.v1.GetDocumentRequest.read_time]
|
50
|
+
# or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
|
51
|
+
# a `read_time` within this window, and will read the state of the database
|
52
|
+
# at that time.
|
53
|
+
#
|
54
|
+
# If the PITR feature is enabled, the retention period is 7 days. Otherwise,
|
55
|
+
# the retention period is 1 hour.
|
56
|
+
# @!attribute [r] earliest_version_time
|
57
|
+
# @return [::Google::Protobuf::Timestamp]
|
58
|
+
# Output only. The earliest timestamp at which older versions of the data can
|
59
|
+
# be read from the database. See [version_retention_period] above; this field
|
60
|
+
# is populated with `now - version_retention_period`.
|
61
|
+
#
|
62
|
+
# This value is continuously updated, and becomes stale the moment it is
|
63
|
+
# queried. If you are using this value to recover data, make sure to account
|
64
|
+
# for the time from the moment when the value is queried to the moment when
|
65
|
+
# you initiate the recovery.
|
66
|
+
# @!attribute [rw] point_in_time_recovery_enablement
|
67
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database::PointInTimeRecoveryEnablement]
|
68
|
+
# Whether to enable the PITR feature on this database.
|
44
69
|
# @!attribute [rw] app_engine_integration_mode
|
45
70
|
# @return [::Google::Cloud::Firestore::Admin::V1::Database::AppEngineIntegrationMode]
|
46
71
|
# The App Engine integration mode to use for this database.
|
47
72
|
# @!attribute [r] key_prefix
|
48
73
|
# @return [::String]
|
49
|
-
# Output only. The key_prefix for this database. This key_prefix is used, in
|
50
|
-
# with the project id ("<key prefix>~<project id>") to construct
|
51
|
-
# application id that is returned from the Cloud Datastore APIs in Google
|
52
|
-
# Engine first generation runtimes.
|
74
|
+
# Output only. The key_prefix for this database. This key_prefix is used, in
|
75
|
+
# combination with the project id ("<key prefix>~<project id>") to construct
|
76
|
+
# the application id that is returned from the Cloud Datastore APIs in Google
|
77
|
+
# App Engine first generation runtimes.
|
53
78
|
#
|
54
79
|
# This value may be empty in which case the appid to use for URL-encoded keys
|
55
80
|
# is the project_id (eg: foo instead of v~foo).
|
@@ -102,6 +127,26 @@ module Google
|
|
102
127
|
OPTIMISTIC_WITH_ENTITY_GROUPS = 3
|
103
128
|
end
|
104
129
|
|
130
|
+
# Point In Time Recovery feature enablement.
|
131
|
+
module PointInTimeRecoveryEnablement
|
132
|
+
# Not used.
|
133
|
+
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED = 0
|
134
|
+
|
135
|
+
# Reads are supported on selected versions of the data from within the past
|
136
|
+
# 7 days:
|
137
|
+
#
|
138
|
+
# * Reads against any timestamp within the past hour
|
139
|
+
# * Reads against 1-minute snapshots beyond 1 hour and within 7 days
|
140
|
+
#
|
141
|
+
# `version_retention_period` and `earliest_version_time` can be
|
142
|
+
# used to determine the supported versions.
|
143
|
+
POINT_IN_TIME_RECOVERY_ENABLED = 1
|
144
|
+
|
145
|
+
# Reads are supported on any version of the data from within the past 1
|
146
|
+
# hour.
|
147
|
+
POINT_IN_TIME_RECOVERY_DISABLED = 2
|
148
|
+
end
|
149
|
+
|
105
150
|
# The type of App Engine integration mode.
|
106
151
|
module AppEngineIntegrationMode
|
107
152
|
# Not used.
|
@@ -113,8 +158,10 @@ module Google
|
|
113
158
|
# the database.
|
114
159
|
ENABLED = 1
|
115
160
|
|
116
|
-
#
|
161
|
+
# App Engine has no effect on the ability of this database to serve
|
117
162
|
# requests.
|
163
|
+
#
|
164
|
+
# This is the default setting for databases created with the Firestore API.
|
118
165
|
DISABLED = 2
|
119
166
|
end
|
120
167
|
end
|
@@ -254,6 +254,23 @@ module Google
|
|
254
254
|
# guidelines: https://cloud.google.com/storage/docs/naming.
|
255
255
|
# If the URI is a bucket (without a namespace path), a prefix will be
|
256
256
|
# generated based on the start time.
|
257
|
+
# @!attribute [rw] namespace_ids
|
258
|
+
# @return [::Array<::String>]
|
259
|
+
# Unspecified means all namespaces. This is the preferred
|
260
|
+
# usage for databases that don't use namespaces.
|
261
|
+
#
|
262
|
+
# An empty string element represents the default namespace. This should be
|
263
|
+
# used if the database has data in non-default namespaces, but doesn't want
|
264
|
+
# to include them. Each namespace in this list must be unique.
|
265
|
+
# @!attribute [rw] snapshot_time
|
266
|
+
# @return [::Google::Protobuf::Timestamp]
|
267
|
+
# The timestamp that corresponds to the version of the database to be
|
268
|
+
# exported. The timestamp must be in the past, rounded to the minute and not
|
269
|
+
# older than
|
270
|
+
# {::Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time earliestVersionTime}.
|
271
|
+
# If specified, then the exported documents will represent a consistent view
|
272
|
+
# of the database at the provided time. Otherwise, there are no guarantees
|
273
|
+
# about the consistency of the exported documents.
|
257
274
|
class ExportDocumentsRequest
|
258
275
|
include ::Google::Protobuf::MessageExts
|
259
276
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -276,6 +293,14 @@ module Google
|
|
276
293
|
# an export that has completed successfully.
|
277
294
|
# See:
|
278
295
|
# {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix}.
|
296
|
+
# @!attribute [rw] namespace_ids
|
297
|
+
# @return [::Array<::String>]
|
298
|
+
# Unspecified means all namespaces. This is the preferred
|
299
|
+
# usage for databases that don't use namespaces.
|
300
|
+
#
|
301
|
+
# An empty string element represents the default namespace. This should be
|
302
|
+
# used if the database has data in non-default namespaces, but doesn't want
|
303
|
+
# to include them. Each namespace in this list must be unique.
|
279
304
|
class ImportDocumentsRequest
|
280
305
|
include ::Google::Protobuf::MessageExts
|
281
306
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -22,7 +22,8 @@ module Google
|
|
22
22
|
module Firestore
|
23
23
|
module Admin
|
24
24
|
module V1
|
25
|
-
# The metadata message for
|
25
|
+
# The metadata message for
|
26
|
+
# `::Google::Cloud::Location::Location#metadata`.
|
26
27
|
class LocationMetadata
|
27
28
|
include ::Google::Protobuf::MessageExts
|
28
29
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -22,7 +22,8 @@ module Google
|
|
22
22
|
module Firestore
|
23
23
|
module Admin
|
24
24
|
module V1
|
25
|
-
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
25
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
26
|
+
# results from
|
26
27
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
|
27
28
|
# @!attribute [rw] start_time
|
28
29
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -49,7 +50,8 @@ module Google
|
|
49
50
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
50
51
|
end
|
51
52
|
|
52
|
-
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
53
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
54
|
+
# results from
|
53
55
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField}.
|
54
56
|
# @!attribute [rw] start_time
|
55
57
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -64,8 +66,9 @@ module Google
|
|
64
66
|
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
|
65
67
|
# @!attribute [rw] index_config_deltas
|
66
68
|
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>]
|
67
|
-
# A list of
|
68
|
-
#
|
69
|
+
# A list of
|
70
|
+
# {::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta IndexConfigDelta},
|
71
|
+
# which describe the intent of this operation.
|
69
72
|
# @!attribute [rw] state
|
70
73
|
# @return [::Google::Cloud::Firestore::Admin::V1::OperationState]
|
71
74
|
# The state of the operation.
|
@@ -106,7 +109,7 @@ module Google
|
|
106
109
|
end
|
107
110
|
end
|
108
111
|
|
109
|
-
# Information about
|
112
|
+
# Information about a TTL configuration change.
|
110
113
|
# @!attribute [rw] change_type
|
111
114
|
# @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
|
112
115
|
# Specifies how the TTL configuration is changing.
|
@@ -128,7 +131,8 @@ module Google
|
|
128
131
|
end
|
129
132
|
end
|
130
133
|
|
131
|
-
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
134
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
135
|
+
# results from
|
132
136
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents FirestoreAdmin.ExportDocuments}.
|
133
137
|
# @!attribute [rw] start_time
|
134
138
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -151,13 +155,22 @@ module Google
|
|
151
155
|
# Which collection ids are being exported.
|
152
156
|
# @!attribute [rw] output_uri_prefix
|
153
157
|
# @return [::String]
|
154
|
-
# Where the
|
158
|
+
# Where the documents are being exported to.
|
159
|
+
# @!attribute [rw] namespace_ids
|
160
|
+
# @return [::Array<::String>]
|
161
|
+
# Which namespace ids are being exported.
|
162
|
+
# @!attribute [rw] snapshot_time
|
163
|
+
# @return [::Google::Protobuf::Timestamp]
|
164
|
+
# The timestamp that corresponds to the version of the database that is being
|
165
|
+
# exported. If unspecified, there are no guarantees about the consistency of
|
166
|
+
# the documents being exported.
|
155
167
|
class ExportDocumentsMetadata
|
156
168
|
include ::Google::Protobuf::MessageExts
|
157
169
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
158
170
|
end
|
159
171
|
|
160
|
-
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
172
|
+
# Metadata for {::Google::Longrunning::Operation google.longrunning.Operation}
|
173
|
+
# results from
|
161
174
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#import_documents FirestoreAdmin.ImportDocuments}.
|
162
175
|
# @!attribute [rw] start_time
|
163
176
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -181,12 +194,16 @@ module Google
|
|
181
194
|
# @!attribute [rw] input_uri_prefix
|
182
195
|
# @return [::String]
|
183
196
|
# The location of the documents being imported.
|
197
|
+
# @!attribute [rw] namespace_ids
|
198
|
+
# @return [::Array<::String>]
|
199
|
+
# Which namespace ids are being imported.
|
184
200
|
class ImportDocumentsMetadata
|
185
201
|
include ::Google::Protobuf::MessageExts
|
186
202
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
187
203
|
end
|
188
204
|
|
189
|
-
# Returned in the {::Google::Longrunning::Operation google.longrunning.Operation}
|
205
|
+
# Returned in the {::Google::Longrunning::Operation google.longrunning.Operation}
|
206
|
+
# response field.
|
190
207
|
# @!attribute [rw] output_uri_prefix
|
191
208
|
# @return [::String]
|
192
209
|
# Location of the output files. This can be used to begin an import
|
@@ -198,8 +215,8 @@ module Google
|
|
198
215
|
end
|
199
216
|
|
200
217
|
# Describes the progress of the operation.
|
201
|
-
# Unit of work is generic and must be interpreted based on where
|
202
|
-
# is used.
|
218
|
+
# Unit of work is generic and must be interpreted based on where
|
219
|
+
# {::Google::Cloud::Firestore::Admin::V1::Progress Progress} is used.
|
203
220
|
# @!attribute [rw] estimated_work
|
204
221
|
# @return [::Integer]
|
205
222
|
# The amount of work estimated.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-firestore-admin-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.12.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: 2023-
|
11
|
+
date: 2023-12-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.20.0
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.20.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
247
247
|
- !ruby/object:Gem::Version
|
248
248
|
version: '0'
|
249
249
|
requirements: []
|
250
|
-
rubygems_version: 3.4.
|
250
|
+
rubygems_version: 3.4.19
|
251
251
|
signing_key:
|
252
252
|
specification_version: 4
|
253
253
|
summary: Accesses the NoSQL document database built for automatic scaling, high performance,
|