google-cloud-firestore-admin-v1 0.8.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +143 -25
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +5 -3
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/client.rb +113 -25
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb +9 -7
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/service_stub.rb +72 -12
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/database_pb.rb +24 -26
- data/lib/google/firestore/admin/v1/field_pb.rb +25 -21
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +30 -63
- data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb +22 -13
- data/lib/google/firestore/admin/v1/index_pb.rb +25 -34
- data/lib/google/firestore/admin/v1/location_pb.rb +24 -3
- data/lib/google/firestore/admin/v1/operation_pb.rb +26 -71
- data/proto_docs/google/api/client.rb +67 -4
- data/proto_docs/google/firestore/admin/v1/firestore_admin.rb +61 -21
- data/proto_docs/google/firestore/admin/v1/index.rb +24 -6
- data/proto_docs/google/protobuf/any.rb +7 -4
- data/proto_docs/google/protobuf/timestamp.rb +1 -3
- metadata +4 -4
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
3
|
# source: google/firestore/admin/v1/operation.proto
|
3
4
|
|
@@ -6,79 +7,33 @@ require 'google/protobuf'
|
|
6
7
|
require 'google/firestore/admin/v1/index_pb'
|
7
8
|
require 'google/protobuf/timestamp_pb'
|
8
9
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
end
|
33
|
-
add_enum "google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType" do
|
34
|
-
value :CHANGE_TYPE_UNSPECIFIED, 0
|
35
|
-
value :ADD, 1
|
36
|
-
value :REMOVE, 2
|
37
|
-
end
|
38
|
-
add_message "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta" do
|
39
|
-
optional :change_type, :enum, 1, "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType"
|
40
|
-
end
|
41
|
-
add_enum "google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType" do
|
42
|
-
value :CHANGE_TYPE_UNSPECIFIED, 0
|
43
|
-
value :ADD, 1
|
44
|
-
value :REMOVE, 2
|
45
|
-
end
|
46
|
-
add_message "google.firestore.admin.v1.ExportDocumentsMetadata" do
|
47
|
-
optional :start_time, :message, 1, "google.protobuf.Timestamp"
|
48
|
-
optional :end_time, :message, 2, "google.protobuf.Timestamp"
|
49
|
-
optional :operation_state, :enum, 3, "google.firestore.admin.v1.OperationState"
|
50
|
-
optional :progress_documents, :message, 4, "google.firestore.admin.v1.Progress"
|
51
|
-
optional :progress_bytes, :message, 5, "google.firestore.admin.v1.Progress"
|
52
|
-
repeated :collection_ids, :string, 6
|
53
|
-
optional :output_uri_prefix, :string, 7
|
54
|
-
end
|
55
|
-
add_message "google.firestore.admin.v1.ImportDocumentsMetadata" do
|
56
|
-
optional :start_time, :message, 1, "google.protobuf.Timestamp"
|
57
|
-
optional :end_time, :message, 2, "google.protobuf.Timestamp"
|
58
|
-
optional :operation_state, :enum, 3, "google.firestore.admin.v1.OperationState"
|
59
|
-
optional :progress_documents, :message, 4, "google.firestore.admin.v1.Progress"
|
60
|
-
optional :progress_bytes, :message, 5, "google.firestore.admin.v1.Progress"
|
61
|
-
repeated :collection_ids, :string, 6
|
62
|
-
optional :input_uri_prefix, :string, 7
|
63
|
-
end
|
64
|
-
add_message "google.firestore.admin.v1.ExportDocumentsResponse" do
|
65
|
-
optional :output_uri_prefix, :string, 1
|
66
|
-
end
|
67
|
-
add_message "google.firestore.admin.v1.Progress" do
|
68
|
-
optional :estimated_work, :int64, 1
|
69
|
-
optional :completed_work, :int64, 2
|
70
|
-
end
|
71
|
-
add_enum "google.firestore.admin.v1.OperationState" do
|
72
|
-
value :OPERATION_STATE_UNSPECIFIED, 0
|
73
|
-
value :INITIALIZING, 1
|
74
|
-
value :PROCESSING, 2
|
75
|
-
value :CANCELLING, 3
|
76
|
-
value :FINALIZING, 4
|
77
|
-
value :SUCCESSFUL, 5
|
78
|
-
value :FAILED, 6
|
79
|
-
value :CANCELLED, 7
|
10
|
+
|
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\"\xec\x02\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\"\xeb\x02\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\"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
|
+
pool = Google::Protobuf::DescriptorPool.generated_pool
|
14
|
+
|
15
|
+
begin
|
16
|
+
pool.add_serialized_file(descriptor_data)
|
17
|
+
rescue TypeError => e
|
18
|
+
# Compatibility code: will be removed in the next major version.
|
19
|
+
require 'google/protobuf/descriptor_pb'
|
20
|
+
parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
|
21
|
+
parsed.clear_dependency
|
22
|
+
serialized = parsed.class.encode(parsed)
|
23
|
+
file = pool.add_serialized_file(serialized)
|
24
|
+
warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
|
25
|
+
imports = [
|
26
|
+
["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
|
27
|
+
["google.firestore.admin.v1.Index", "google/firestore/admin/v1/index.proto"],
|
28
|
+
]
|
29
|
+
imports.each do |type_name, expected_filename|
|
30
|
+
import_file = pool.lookup(type_name).file_descriptor
|
31
|
+
if import_file.name != expected_filename
|
32
|
+
warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
|
80
33
|
end
|
81
34
|
end
|
35
|
+
warn "Each proto file must use a consistent fully-qualified name."
|
36
|
+
warn "This will become an error in the next major version."
|
82
37
|
end
|
83
38
|
|
84
39
|
module Google
|
@@ -35,7 +35,9 @@ module Google
|
|
35
35
|
# Details about how and where to publish client libraries.
|
36
36
|
# @!attribute [rw] version
|
37
37
|
# @return [::String]
|
38
|
-
# Version of the API to apply these settings to.
|
38
|
+
# Version of the API to apply these settings to. This is the full protobuf
|
39
|
+
# package for the API, ending in the version element.
|
40
|
+
# Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
39
41
|
# @!attribute [rw] launch_stage
|
40
42
|
# @return [::Google::Api::LaunchStage]
|
41
43
|
# Launch stage of this version of the API.
|
@@ -81,7 +83,7 @@ module Google
|
|
81
83
|
# long-running operation pattern.
|
82
84
|
# @!attribute [rw] new_issue_uri
|
83
85
|
# @return [::String]
|
84
|
-
# Link to a
|
86
|
+
# Link to a *public* URI where users can report issues. Example:
|
85
87
|
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
86
88
|
# @!attribute [rw] documentation_uri
|
87
89
|
# @return [::String]
|
@@ -111,6 +113,10 @@ module Google
|
|
111
113
|
# Client library settings. If the same version string appears multiple
|
112
114
|
# times in this list, then the last one wins. Settings from earlier
|
113
115
|
# settings with the same version string are discarded.
|
116
|
+
# @!attribute [rw] proto_reference_documentation_uri
|
117
|
+
# @return [::String]
|
118
|
+
# Optional link to proto reference documentation. Example:
|
119
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
114
120
|
class Publishing
|
115
121
|
include ::Google::Protobuf::MessageExts
|
116
122
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -203,9 +209,57 @@ module Google
|
|
203
209
|
# @!attribute [rw] common
|
204
210
|
# @return [::Google::Api::CommonLanguageSettings]
|
205
211
|
# Some settings.
|
212
|
+
# @!attribute [rw] renamed_services
|
213
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
214
|
+
# Map from original service names to renamed versions.
|
215
|
+
# This is used when the default generated types
|
216
|
+
# would cause a naming conflict. (Neither name is
|
217
|
+
# fully-qualified.)
|
218
|
+
# Example: Subscriber to SubscriberServiceApi.
|
219
|
+
# @!attribute [rw] renamed_resources
|
220
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
221
|
+
# Map from full resource types to the effective short name
|
222
|
+
# for the resource. This is used when otherwise resource
|
223
|
+
# named from different services would cause naming collisions.
|
224
|
+
# Example entry:
|
225
|
+
# "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
226
|
+
# @!attribute [rw] ignored_resources
|
227
|
+
# @return [::Array<::String>]
|
228
|
+
# List of full resource types to ignore during generation.
|
229
|
+
# This is typically used for API-specific Location resources,
|
230
|
+
# which should be handled by the generator as if they were actually
|
231
|
+
# the common Location resources.
|
232
|
+
# Example entry: "documentai.googleapis.com/Location"
|
233
|
+
# @!attribute [rw] forced_namespace_aliases
|
234
|
+
# @return [::Array<::String>]
|
235
|
+
# Namespaces which must be aliased in snippets due to
|
236
|
+
# a known (but non-generator-predictable) naming collision
|
237
|
+
# @!attribute [rw] handwritten_signatures
|
238
|
+
# @return [::Array<::String>]
|
239
|
+
# Method signatures (in the form "service.method(signature)")
|
240
|
+
# which are provided separately, so shouldn't be generated.
|
241
|
+
# Snippets *calling* these methods are still generated, however.
|
206
242
|
class DotnetSettings
|
207
243
|
include ::Google::Protobuf::MessageExts
|
208
244
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
|
+
|
246
|
+
# @!attribute [rw] key
|
247
|
+
# @return [::String]
|
248
|
+
# @!attribute [rw] value
|
249
|
+
# @return [::String]
|
250
|
+
class RenamedServicesEntry
|
251
|
+
include ::Google::Protobuf::MessageExts
|
252
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
253
|
+
end
|
254
|
+
|
255
|
+
# @!attribute [rw] key
|
256
|
+
# @return [::String]
|
257
|
+
# @!attribute [rw] value
|
258
|
+
# @return [::String]
|
259
|
+
class RenamedResourcesEntry
|
260
|
+
include ::Google::Protobuf::MessageExts
|
261
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
262
|
+
end
|
209
263
|
end
|
210
264
|
|
211
265
|
# Settings for Ruby client libraries.
|
@@ -240,8 +294,8 @@ module Google
|
|
240
294
|
# Example of a YAML configuration::
|
241
295
|
#
|
242
296
|
# publishing:
|
243
|
-
#
|
244
|
-
# - selector:
|
297
|
+
# method_settings:
|
298
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
245
299
|
# long_running:
|
246
300
|
# initial_poll_delay:
|
247
301
|
# seconds: 60 # 1 minute
|
@@ -299,6 +353,15 @@ module Google
|
|
299
353
|
|
300
354
|
# Street View Org.
|
301
355
|
STREET_VIEW = 4
|
356
|
+
|
357
|
+
# Shopping Org.
|
358
|
+
SHOPPING = 5
|
359
|
+
|
360
|
+
# Geo Org.
|
361
|
+
GEO = 6
|
362
|
+
|
363
|
+
# Generative AI - https://developers.generativeai.google
|
364
|
+
GENERATIVE_AI = 7
|
302
365
|
end
|
303
366
|
|
304
367
|
# To where should client libraries be published?
|
@@ -32,6 +32,32 @@ module Google
|
|
32
32
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
33
|
end
|
34
34
|
|
35
|
+
# The request for
|
36
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_database FirestoreAdmin.CreateDatabase}.
|
37
|
+
# @!attribute [rw] parent
|
38
|
+
# @return [::String]
|
39
|
+
# Required. A parent name of the form
|
40
|
+
# `projects/{project_id}`
|
41
|
+
# @!attribute [rw] database
|
42
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
|
43
|
+
# Required. The Database to create.
|
44
|
+
# @!attribute [rw] database_id
|
45
|
+
# @return [::String]
|
46
|
+
# Required. The ID to use for the database, which will become the final
|
47
|
+
# component of the database's resource name.
|
48
|
+
#
|
49
|
+
# The value must be set to "(default)".
|
50
|
+
class CreateDatabaseRequest
|
51
|
+
include ::Google::Protobuf::MessageExts
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
53
|
+
end
|
54
|
+
|
55
|
+
# Metadata related to the create database operation.
|
56
|
+
class CreateDatabaseMetadata
|
57
|
+
include ::Google::Protobuf::MessageExts
|
58
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
59
|
+
end
|
60
|
+
|
35
61
|
# The list of databases for a project.
|
36
62
|
# @!attribute [rw] databases
|
37
63
|
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Database>]
|
@@ -41,7 +67,8 @@ module Google
|
|
41
67
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
42
68
|
end
|
43
69
|
|
44
|
-
# The request for
|
70
|
+
# The request for
|
71
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_database FirestoreAdmin.GetDatabase}.
|
45
72
|
# @!attribute [rw] name
|
46
73
|
# @return [::String]
|
47
74
|
# Required. A name of the form
|
@@ -51,7 +78,8 @@ module Google
|
|
51
78
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
79
|
end
|
53
80
|
|
54
|
-
# The request for
|
81
|
+
# The request for
|
82
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_database FirestoreAdmin.UpdateDatabase}.
|
55
83
|
# @!attribute [rw] database
|
56
84
|
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
|
57
85
|
# Required. The database to update.
|
@@ -69,7 +97,8 @@ module Google
|
|
69
97
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
98
|
end
|
71
99
|
|
72
|
-
# The request for
|
100
|
+
# The request for
|
101
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
|
73
102
|
# @!attribute [rw] parent
|
74
103
|
# @return [::String]
|
75
104
|
# Required. A parent name of the form
|
@@ -82,7 +111,8 @@ module Google
|
|
82
111
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
112
|
end
|
84
113
|
|
85
|
-
# The request for
|
114
|
+
# The request for
|
115
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}.
|
86
116
|
# @!attribute [rw] parent
|
87
117
|
# @return [::String]
|
88
118
|
# Required. A parent name of the form
|
@@ -96,14 +126,15 @@ module Google
|
|
96
126
|
# @!attribute [rw] page_token
|
97
127
|
# @return [::String]
|
98
128
|
# A page token, returned from a previous call to
|
99
|
-
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes},
|
100
|
-
# page of results.
|
129
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes},
|
130
|
+
# that may be used to get the next page of results.
|
101
131
|
class ListIndexesRequest
|
102
132
|
include ::Google::Protobuf::MessageExts
|
103
133
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
134
|
end
|
105
135
|
|
106
|
-
# The response for
|
136
|
+
# The response for
|
137
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes FirestoreAdmin.ListIndexes}.
|
107
138
|
# @!attribute [rw] indexes
|
108
139
|
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index>]
|
109
140
|
# The requested indexes.
|
@@ -116,7 +147,8 @@ module Google
|
|
116
147
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
117
148
|
end
|
118
149
|
|
119
|
-
# The request for
|
150
|
+
# The request for
|
151
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_index FirestoreAdmin.GetIndex}.
|
120
152
|
# @!attribute [rw] name
|
121
153
|
# @return [::String]
|
122
154
|
# Required. A name of the form
|
@@ -126,7 +158,8 @@ module Google
|
|
126
158
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
159
|
end
|
128
160
|
|
129
|
-
# The request for
|
161
|
+
# The request for
|
162
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#delete_index FirestoreAdmin.DeleteIndex}.
|
130
163
|
# @!attribute [rw] name
|
131
164
|
# @return [::String]
|
132
165
|
# Required. A name of the form
|
@@ -136,7 +169,8 @@ module Google
|
|
136
169
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
137
170
|
end
|
138
171
|
|
139
|
-
# The request for
|
172
|
+
# The request for
|
173
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field FirestoreAdmin.UpdateField}.
|
140
174
|
# @!attribute [rw] field
|
141
175
|
# @return [::Google::Cloud::Firestore::Admin::V1::Field]
|
142
176
|
# Required. The field to be updated.
|
@@ -149,7 +183,8 @@ module Google
|
|
149
183
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
184
|
end
|
151
185
|
|
152
|
-
# The request for
|
186
|
+
# The request for
|
187
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_field FirestoreAdmin.GetField}.
|
153
188
|
# @!attribute [rw] name
|
154
189
|
# @return [::String]
|
155
190
|
# Required. A name of the form
|
@@ -159,7 +194,8 @@ module Google
|
|
159
194
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
160
195
|
end
|
161
196
|
|
162
|
-
# The request for
|
197
|
+
# The request for
|
198
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}.
|
163
199
|
# @!attribute [rw] parent
|
164
200
|
# @return [::String]
|
165
201
|
# Required. A parent name of the form
|
@@ -167,24 +203,26 @@ module Google
|
|
167
203
|
# @!attribute [rw] filter
|
168
204
|
# @return [::String]
|
169
205
|
# The filter to apply to list results. Currently,
|
170
|
-
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}
|
171
|
-
# that have been explicitly overridden. To issue
|
172
|
-
#
|
173
|
-
#
|
206
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}
|
207
|
+
# only supports listing fields that have been explicitly overridden. To issue
|
208
|
+
# this query, call
|
209
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}
|
210
|
+
# with a filter that includes `indexConfig.usesAncestorConfig:false` .
|
174
211
|
# @!attribute [rw] page_size
|
175
212
|
# @return [::Integer]
|
176
213
|
# The number of results to return.
|
177
214
|
# @!attribute [rw] page_token
|
178
215
|
# @return [::String]
|
179
216
|
# A page token, returned from a previous call to
|
180
|
-
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields},
|
181
|
-
# page of results.
|
217
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields},
|
218
|
+
# that may be used to get the next page of results.
|
182
219
|
class ListFieldsRequest
|
183
220
|
include ::Google::Protobuf::MessageExts
|
184
221
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
185
222
|
end
|
186
223
|
|
187
|
-
# The response for
|
224
|
+
# The response for
|
225
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields}.
|
188
226
|
# @!attribute [rw] fields
|
189
227
|
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Field>]
|
190
228
|
# The requested fields.
|
@@ -197,7 +235,8 @@ module Google
|
|
197
235
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
236
|
end
|
199
237
|
|
200
|
-
# The request for
|
238
|
+
# The request for
|
239
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents FirestoreAdmin.ExportDocuments}.
|
201
240
|
# @!attribute [rw] name
|
202
241
|
# @return [::String]
|
203
242
|
# Required. Database to export. Should be of the form:
|
@@ -220,7 +259,8 @@ module Google
|
|
220
259
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
221
260
|
end
|
222
261
|
|
223
|
-
# The request for
|
262
|
+
# The request for
|
263
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#import_documents FirestoreAdmin.ImportDocuments}.
|
224
264
|
# @!attribute [rw] name
|
225
265
|
# @return [::String]
|
226
266
|
# Required. Database to import into. Should be of the form:
|
@@ -39,16 +39,19 @@ module Google
|
|
39
39
|
# Indexes with a collection group query scope specified allow queries against
|
40
40
|
# all collections descended from a specific document, specified at query
|
41
41
|
# time, and that have the same collection id as this index.
|
42
|
+
# @!attribute [rw] api_scope
|
43
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::ApiScope]
|
44
|
+
# The API scope supported by this index.
|
42
45
|
# @!attribute [rw] fields
|
43
46
|
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>]
|
44
47
|
# The fields supported by this index.
|
45
48
|
#
|
46
|
-
# For composite indexes, this
|
47
|
-
# The last field entry is always for the field path `__name__`. If,
|
48
|
-
# creation, `__name__` was not specified as the last field, it will be
|
49
|
-
# automatically with the same direction as that of the last field
|
50
|
-
# the final field in a composite index is not directional, the
|
51
|
-
# will be ordered ASCENDING (unless explicitly specified).
|
49
|
+
# For composite indexes, this requires a minimum of 2 and a maximum of 100
|
50
|
+
# fields. The last field entry is always for the field path `__name__`. If,
|
51
|
+
# on creation, `__name__` was not specified as the last field, it will be
|
52
|
+
# added automatically with the same direction as that of the last field
|
53
|
+
# defined. If the final field in a composite index is not directional, the
|
54
|
+
# `__name__` will be ordered ASCENDING (unless explicitly specified).
|
52
55
|
#
|
53
56
|
# For single field indexes, this will always be exactly one entry with a
|
54
57
|
# field path equal to the field path of the associated field.
|
@@ -115,6 +118,21 @@ module Google
|
|
115
118
|
# against all collections that has the collection id specified by the
|
116
119
|
# index.
|
117
120
|
COLLECTION_GROUP = 2
|
121
|
+
|
122
|
+
# Include all the collections's ancestor in the index. Only available for
|
123
|
+
# Datastore Mode databases.
|
124
|
+
COLLECTION_RECURSIVE = 3
|
125
|
+
end
|
126
|
+
|
127
|
+
# API Scope defines the APIs (Firestore Native, or Firestore in
|
128
|
+
# Datastore Mode) that are supported for queries.
|
129
|
+
module ApiScope
|
130
|
+
# The index can only be used by the Firestore Native query API.
|
131
|
+
# This is the default.
|
132
|
+
ANY_API = 0
|
133
|
+
|
134
|
+
# The index can only be used by the Firestore in Datastore Mode query API.
|
135
|
+
DATASTORE_MODE_API = 1
|
118
136
|
end
|
119
137
|
|
120
138
|
# The state of an index. During index creation, an index will be in the
|
@@ -43,8 +43,12 @@ module Google
|
|
43
43
|
# if (any.is(Foo.class)) {
|
44
44
|
# foo = any.unpack(Foo.class);
|
45
45
|
# }
|
46
|
+
# // or ...
|
47
|
+
# if (any.isSameTypeAs(Foo.getDefaultInstance())) {
|
48
|
+
# foo = any.unpack(Foo.getDefaultInstance());
|
49
|
+
# }
|
46
50
|
#
|
47
|
-
#
|
51
|
+
# Example 3: Pack and unpack a message in Python.
|
48
52
|
#
|
49
53
|
# foo = Foo(...)
|
50
54
|
# any = Any()
|
@@ -54,7 +58,7 @@ module Google
|
|
54
58
|
# any.Unpack(foo)
|
55
59
|
# ...
|
56
60
|
#
|
57
|
-
#
|
61
|
+
# Example 4: Pack and unpack a message in Go
|
58
62
|
#
|
59
63
|
# foo := &pb.Foo{...}
|
60
64
|
# any, err := anypb.New(foo)
|
@@ -73,9 +77,8 @@ module Google
|
|
73
77
|
# in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
74
78
|
# name "y.z".
|
75
79
|
#
|
76
|
-
#
|
77
80
|
# JSON
|
78
|
-
#
|
81
|
+
# ====
|
79
82
|
# The JSON representation of an `Any` value uses the regular
|
80
83
|
# representation of the deserialized, embedded message, with an
|
81
84
|
# additional field `@type` which contains the type URL. Example:
|
@@ -69,7 +69,6 @@ module Google
|
|
69
69
|
# Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
71
71
|
#
|
72
|
-
#
|
73
72
|
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
74
73
|
#
|
75
74
|
# Instant now = Instant.now();
|
@@ -78,7 +77,6 @@ module Google
|
|
78
77
|
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
79
78
|
# .setNanos(now.getNano()).build();
|
80
79
|
#
|
81
|
-
#
|
82
80
|
# Example 6: Compute Timestamp from current time in Python.
|
83
81
|
#
|
84
82
|
# timestamp = Timestamp()
|
@@ -108,7 +106,7 @@ module Google
|
|
108
106
|
# [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
109
107
|
# the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
110
108
|
# the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
111
|
-
# http://
|
109
|
+
# http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
|
112
110
|
# ) to obtain a formatter capable of generating timestamps in this format.
|
113
111
|
# @!attribute [rw] seconds
|
114
112
|
# @return [::Integer]
|
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.10.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-06-06 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.19.1
|
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.19.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|