google-cloud-firestore-admin-v1 1.11.0 → 1.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/field_pb.rb +2 -1
- data/lib/google/firestore/admin/v1/operation_pb.rb +2 -1
- data/proto_docs/google/api/client.rb +149 -29
- data/proto_docs/google/api/routing.rb +7 -3
- data/proto_docs/google/firestore/admin/v1/field.rb +17 -5
- data/proto_docs/google/firestore/admin/v1/operation.rb +4 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 54e9d83cc08cd200025c5f9c971752795010cc76d0790d5d837bb726b1ff613b
|
|
4
|
+
data.tar.gz: d1271c4f008761f8d64d1182ddf1340eb36ccf1961cbb391c7b717fb767d3371
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 81b98984b0024f7bc14bf1714d87882fbac2f840fb77f4eeaf59028007de0b2667da3aadbff9ba1f610374e8532a20cfae4edbad863af6898bac58d787307a9e
|
|
7
|
+
data.tar.gz: 4c7e19cd755b689c90eefea7099806362031eef1daec112cbed8f3d2c9e0a91becd3e380003a4255b86b75bf61e62be35558137d0a2959d3c5401ec0e5d727c6
|
|
@@ -7,9 +7,10 @@ require 'google/protobuf'
|
|
|
7
7
|
require 'google/api/field_behavior_pb'
|
|
8
8
|
require 'google/api/resource_pb'
|
|
9
9
|
require 'google/firestore/admin/v1/index_pb'
|
|
10
|
+
require 'google/protobuf/duration_pb'
|
|
10
11
|
|
|
11
12
|
|
|
12
|
-
descriptor_data = "\n%google/firestore/admin/v1/field.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a%google/firestore/admin/v1/index.proto\"\
|
|
13
|
+
descriptor_data = "\n%google/firestore/admin/v1/field.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a%google/firestore/admin/v1/index.proto\x1a\x1egoogle/protobuf/duration.proto\"\x80\x05\n\x05\x46ield\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x42\n\x0cindex_config\x18\x02 \x01(\x0b\x32,.google.firestore.admin.v1.Field.IndexConfig\x12>\n\nttl_config\x18\x03 \x01(\x0b\x32*.google.firestore.admin.v1.Field.TtlConfig\x1a\x89\x01\n\x0bIndexConfig\x12\x31\n\x07indexes\x18\x01 \x03(\x0b\x32 .google.firestore.admin.v1.Index\x12\x1c\n\x14uses_ancestor_config\x18\x02 \x01(\x08\x12\x16\n\x0e\x61ncestor_field\x18\x03 \x01(\t\x12\x11\n\treverting\x18\x04 \x01(\x08\x1a\xd8\x01\n\tTtlConfig\x12\x44\n\x05state\x18\x01 \x01(\x0e\x32\x30.google.firestore.admin.v1.Field.TtlConfig.StateB\x03\xe0\x41\x03\x12\x39\n\x11\x65xpiration_offset\x18\x03 \x01(\x0b\x32\x19.google.protobuf.DurationB\x03\xe0\x41\x01\"J\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43REATING\x10\x01\x12\n\n\x06\x41\x43TIVE\x10\x02\x12\x10\n\x0cNEEDS_REPAIR\x10\x03:y\xea\x41v\n\x1e\x66irestore.googleapis.com/Field\x12Tprojects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}B\xd9\x01\n\x1d\x63om.google.firestore.admin.v1B\nFieldProtoP\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"
|
|
13
14
|
|
|
14
15
|
pool = ::Google::Protobuf::DescriptorPool.generated_pool
|
|
15
16
|
pool.add_serialized_file(descriptor_data)
|
|
@@ -7,10 +7,11 @@ require 'google/protobuf'
|
|
|
7
7
|
require 'google/api/resource_pb'
|
|
8
8
|
require 'google/firestore/admin/v1/index_pb'
|
|
9
9
|
require 'google/firestore/admin/v1/snapshot_pb'
|
|
10
|
+
require 'google/protobuf/duration_pb'
|
|
10
11
|
require 'google/protobuf/timestamp_pb'
|
|
11
12
|
|
|
12
13
|
|
|
13
|
-
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(google/firestore/admin/v1/snapshot.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\"\
|
|
14
|
+
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(google/firestore/admin/v1/snapshot.proto\x1a\x1egoogle/protobuf/duration.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\"\xcf\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\xe8\x01\n\x0eTtlConfigDelta\x12`\n\x0b\x63hange_type\x18\x01 \x01(\x0e\x32K.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType\x12\x34\n\x11\x65xpiration_offset\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\">\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\"\x9f\x03\n\x1b\x42ulkDeleteDocumentsMetadata\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\x15\n\rnamespace_ids\x18\x07 \x03(\t\x12\x31\n\rsnapshot_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"4\n\x17\x45xportDocumentsResponse\x12\x19\n\x11output_uri_prefix\x18\x01 \x01(\t\"\xed\x02\n\x17RestoreDatabaseMetadata\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\x38\n\x08\x64\x61tabase\x18\x04 \x01(\tB&\xfa\x41#\n!firestore.googleapis.com/Database\x12\x34\n\x06\x62\x61\x63kup\x18\x05 \x01(\tB$\xfa\x41!\n\x1f\x66irestore.googleapis.com/Backup\x12@\n\x13progress_percentage\x18\x08 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\"\xf5\x02\n\x15\x43loneDatabaseMetadata\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\x38\n\x08\x64\x61tabase\x18\x04 \x01(\tB&\xfa\x41#\n!firestore.googleapis.com/Database\x12>\n\rpitr_snapshot\x18\x07 \x01(\x0b\x32\'.google.firestore.admin.v1.PitrSnapshot\x12@\n\x13progress_percentage\x18\x06 \x01(\x0b\x32#.google.firestore.admin.v1.Progress\":\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"
|
|
14
15
|
|
|
15
16
|
pool = ::Google::Protobuf::DescriptorPool.generated_pool
|
|
16
17
|
pool.add_serialized_file(descriptor_data)
|
|
@@ -31,6 +31,8 @@ module Google
|
|
|
31
31
|
# @!attribute [rw] selective_gapic_generation
|
|
32
32
|
# @return [::Google::Api::SelectiveGapicGeneration]
|
|
33
33
|
# Configuration for which RPCs should be generated in the GAPIC client.
|
|
34
|
+
#
|
|
35
|
+
# Note: This field should not be used in most cases.
|
|
34
36
|
class CommonLanguageSettings
|
|
35
37
|
include ::Google::Protobuf::MessageExts
|
|
36
38
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -141,9 +143,10 @@ module Google
|
|
|
141
143
|
#
|
|
142
144
|
# Example of a YAML configuration::
|
|
143
145
|
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
146
|
+
# publishing:
|
|
147
|
+
# library_settings:
|
|
148
|
+
# java_settings:
|
|
149
|
+
# library_package: com.google.cloud.pubsub.v1
|
|
147
150
|
# @!attribute [rw] service_class_names
|
|
148
151
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
149
152
|
# Configure the Java class name to use instead of the service's for its
|
|
@@ -155,11 +158,11 @@ module Google
|
|
|
155
158
|
#
|
|
156
159
|
# Example of a YAML configuration::
|
|
157
160
|
#
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
162
|
-
#
|
|
161
|
+
# publishing:
|
|
162
|
+
# java_settings:
|
|
163
|
+
# service_class_names:
|
|
164
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
|
165
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
|
163
166
|
# @!attribute [rw] common
|
|
164
167
|
# @return [::Google::Api::CommonLanguageSettings]
|
|
165
168
|
# Some settings.
|
|
@@ -190,6 +193,20 @@ module Google
|
|
|
190
193
|
# @!attribute [rw] common
|
|
191
194
|
# @return [::Google::Api::CommonLanguageSettings]
|
|
192
195
|
# Some settings.
|
|
196
|
+
# @!attribute [rw] library_package
|
|
197
|
+
# @return [::String]
|
|
198
|
+
# The package name to use in Php. Clobbers the php_namespace option
|
|
199
|
+
# set in the protobuf. This should be used **only** by APIs
|
|
200
|
+
# who have already set the language_settings.php.package_name" field
|
|
201
|
+
# in gapic.yaml. API teams should use the protobuf php_namespace option
|
|
202
|
+
# where possible.
|
|
203
|
+
#
|
|
204
|
+
# Example of a YAML configuration::
|
|
205
|
+
#
|
|
206
|
+
# publishing:
|
|
207
|
+
# library_settings:
|
|
208
|
+
# php_settings:
|
|
209
|
+
# library_package: Google\Cloud\PubSub\V1
|
|
193
210
|
class PhpSettings
|
|
194
211
|
include ::Google::Protobuf::MessageExts
|
|
195
212
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -318,10 +335,12 @@ module Google
|
|
|
318
335
|
# service names and values are the name to be used for the service client
|
|
319
336
|
# and call options.
|
|
320
337
|
#
|
|
321
|
-
#
|
|
322
|
-
#
|
|
323
|
-
#
|
|
324
|
-
#
|
|
338
|
+
# Example:
|
|
339
|
+
#
|
|
340
|
+
# publishing:
|
|
341
|
+
# go_settings:
|
|
342
|
+
# renamed_services:
|
|
343
|
+
# Publisher: TopicAdmin
|
|
325
344
|
class GoSettings
|
|
326
345
|
include ::Google::Protobuf::MessageExts
|
|
327
346
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -344,10 +363,10 @@ module Google
|
|
|
344
363
|
#
|
|
345
364
|
# Example:
|
|
346
365
|
#
|
|
347
|
-
#
|
|
348
|
-
#
|
|
349
|
-
#
|
|
350
|
-
#
|
|
366
|
+
# publishing:
|
|
367
|
+
# method_settings:
|
|
368
|
+
# - selector: google.storage.control.v2.StorageControl.CreateFolder
|
|
369
|
+
# # method settings for CreateFolder...
|
|
351
370
|
# @!attribute [rw] long_running
|
|
352
371
|
# @return [::Google::Api::MethodSettings::LongRunning]
|
|
353
372
|
# Describes settings to use for long-running operations when generating
|
|
@@ -356,14 +375,14 @@ module Google
|
|
|
356
375
|
#
|
|
357
376
|
# Example of a YAML configuration::
|
|
358
377
|
#
|
|
359
|
-
#
|
|
360
|
-
#
|
|
361
|
-
#
|
|
362
|
-
#
|
|
363
|
-
#
|
|
364
|
-
#
|
|
365
|
-
#
|
|
366
|
-
#
|
|
378
|
+
# publishing:
|
|
379
|
+
# method_settings:
|
|
380
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
381
|
+
# long_running:
|
|
382
|
+
# initial_poll_delay: 60s # 1 minute
|
|
383
|
+
# poll_delay_multiplier: 1.5
|
|
384
|
+
# max_poll_delay: 360s # 6 minutes
|
|
385
|
+
# total_poll_timeout: 54000s # 90 minutes
|
|
367
386
|
# @!attribute [rw] auto_populated_fields
|
|
368
387
|
# @return [::Array<::String>]
|
|
369
388
|
# List of top-level fields of the request message, that should be
|
|
@@ -372,11 +391,24 @@ module Google
|
|
|
372
391
|
#
|
|
373
392
|
# Example of a YAML configuration:
|
|
374
393
|
#
|
|
375
|
-
#
|
|
376
|
-
#
|
|
377
|
-
#
|
|
378
|
-
#
|
|
379
|
-
#
|
|
394
|
+
# publishing:
|
|
395
|
+
# method_settings:
|
|
396
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
397
|
+
# auto_populated_fields:
|
|
398
|
+
# - request_id
|
|
399
|
+
# @!attribute [rw] batching
|
|
400
|
+
# @return [::Google::Api::BatchingConfigProto]
|
|
401
|
+
# Batching configuration for an API method in client libraries.
|
|
402
|
+
#
|
|
403
|
+
# Example of a YAML configuration:
|
|
404
|
+
#
|
|
405
|
+
# publishing:
|
|
406
|
+
# method_settings:
|
|
407
|
+
# - selector: google.example.v1.ExampleService.BatchCreateExample
|
|
408
|
+
# batching:
|
|
409
|
+
# element_count_threshold: 1000
|
|
410
|
+
# request_byte_threshold: 100000000
|
|
411
|
+
# delay_threshold_millis: 10
|
|
380
412
|
class MethodSettings
|
|
381
413
|
include ::Google::Protobuf::MessageExts
|
|
382
414
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -411,6 +443,8 @@ module Google
|
|
|
411
443
|
|
|
412
444
|
# This message is used to configure the generation of a subset of the RPCs in
|
|
413
445
|
# a service for client libraries.
|
|
446
|
+
#
|
|
447
|
+
# Note: This feature should not be used in most cases.
|
|
414
448
|
# @!attribute [rw] methods
|
|
415
449
|
# @return [::Array<::String>]
|
|
416
450
|
# An allowlist of the fully qualified names of RPCs that should be included
|
|
@@ -428,6 +462,77 @@ module Google
|
|
|
428
462
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
429
463
|
end
|
|
430
464
|
|
|
465
|
+
# `BatchingConfigProto` defines the batching configuration for an API method.
|
|
466
|
+
# @!attribute [rw] thresholds
|
|
467
|
+
# @return [::Google::Api::BatchingSettingsProto]
|
|
468
|
+
# The thresholds which trigger a batched request to be sent.
|
|
469
|
+
# @!attribute [rw] batch_descriptor
|
|
470
|
+
# @return [::Google::Api::BatchingDescriptorProto]
|
|
471
|
+
# The request and response fields used in batching.
|
|
472
|
+
class BatchingConfigProto
|
|
473
|
+
include ::Google::Protobuf::MessageExts
|
|
474
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
475
|
+
end
|
|
476
|
+
|
|
477
|
+
# `BatchingSettingsProto` specifies a set of batching thresholds, each of
|
|
478
|
+
# which acts as a trigger to send a batch of messages as a request. At least
|
|
479
|
+
# one threshold must be positive nonzero.
|
|
480
|
+
# @!attribute [rw] element_count_threshold
|
|
481
|
+
# @return [::Integer]
|
|
482
|
+
# The number of elements of a field collected into a batch which, if
|
|
483
|
+
# exceeded, causes the batch to be sent.
|
|
484
|
+
# @!attribute [rw] request_byte_threshold
|
|
485
|
+
# @return [::Integer]
|
|
486
|
+
# The aggregated size of the batched field which, if exceeded, causes the
|
|
487
|
+
# batch to be sent. This size is computed by aggregating the sizes of the
|
|
488
|
+
# request field to be batched, not of the entire request message.
|
|
489
|
+
# @!attribute [rw] delay_threshold
|
|
490
|
+
# @return [::Google::Protobuf::Duration]
|
|
491
|
+
# The duration after which a batch should be sent, starting from the addition
|
|
492
|
+
# of the first message to that batch.
|
|
493
|
+
# @!attribute [rw] element_count_limit
|
|
494
|
+
# @return [::Integer]
|
|
495
|
+
# The maximum number of elements collected in a batch that could be accepted
|
|
496
|
+
# by server.
|
|
497
|
+
# @!attribute [rw] request_byte_limit
|
|
498
|
+
# @return [::Integer]
|
|
499
|
+
# The maximum size of the request that could be accepted by server.
|
|
500
|
+
# @!attribute [rw] flow_control_element_limit
|
|
501
|
+
# @return [::Integer]
|
|
502
|
+
# The maximum number of elements allowed by flow control.
|
|
503
|
+
# @!attribute [rw] flow_control_byte_limit
|
|
504
|
+
# @return [::Integer]
|
|
505
|
+
# The maximum size of data allowed by flow control.
|
|
506
|
+
# @!attribute [rw] flow_control_limit_exceeded_behavior
|
|
507
|
+
# @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
|
|
508
|
+
# The behavior to take when the flow control limit is exceeded.
|
|
509
|
+
class BatchingSettingsProto
|
|
510
|
+
include ::Google::Protobuf::MessageExts
|
|
511
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
512
|
+
end
|
|
513
|
+
|
|
514
|
+
# `BatchingDescriptorProto` specifies the fields of the request message to be
|
|
515
|
+
# used for batching, and, optionally, the fields of the response message to be
|
|
516
|
+
# used for demultiplexing.
|
|
517
|
+
# @!attribute [rw] batched_field
|
|
518
|
+
# @return [::String]
|
|
519
|
+
# The repeated field in the request message to be aggregated by batching.
|
|
520
|
+
# @!attribute [rw] discriminator_fields
|
|
521
|
+
# @return [::Array<::String>]
|
|
522
|
+
# A list of the fields in the request message. Two requests will be batched
|
|
523
|
+
# together only if the values of every field specified in
|
|
524
|
+
# `request_discriminator_fields` is equal between the two requests.
|
|
525
|
+
# @!attribute [rw] subresponse_field
|
|
526
|
+
# @return [::String]
|
|
527
|
+
# Optional. When present, indicates the field in the response message to be
|
|
528
|
+
# used to demultiplex the response into multiple response messages, in
|
|
529
|
+
# correspondence with the multiple request messages originally batched
|
|
530
|
+
# together.
|
|
531
|
+
class BatchingDescriptorProto
|
|
532
|
+
include ::Google::Protobuf::MessageExts
|
|
533
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
534
|
+
end
|
|
535
|
+
|
|
431
536
|
# The organization for which the client libraries are being published.
|
|
432
537
|
# Affects the url where generated docs are published, etc.
|
|
433
538
|
module ClientLibraryOrganization
|
|
@@ -469,5 +574,20 @@ module Google
|
|
|
469
574
|
# Publish the library to package managers like nuget.org and npmjs.com.
|
|
470
575
|
PACKAGE_MANAGER = 20
|
|
471
576
|
end
|
|
577
|
+
|
|
578
|
+
# The behavior to take when the flow control limit is exceeded.
|
|
579
|
+
module FlowControlLimitExceededBehaviorProto
|
|
580
|
+
# Default behavior, system-defined.
|
|
581
|
+
UNSET_BEHAVIOR = 0
|
|
582
|
+
|
|
583
|
+
# Stop operation, raise error.
|
|
584
|
+
THROW_EXCEPTION = 1
|
|
585
|
+
|
|
586
|
+
# Pause operation until limit clears.
|
|
587
|
+
BLOCK = 2
|
|
588
|
+
|
|
589
|
+
# Continue operation, disregard limit.
|
|
590
|
+
IGNORE = 3
|
|
591
|
+
end
|
|
472
592
|
end
|
|
473
593
|
end
|
|
@@ -49,9 +49,13 @@ module Google
|
|
|
49
49
|
# app_profile_id: profiles/prof_qux
|
|
50
50
|
# }
|
|
51
51
|
#
|
|
52
|
-
# The routing header consists of one or multiple key-value pairs.
|
|
53
|
-
#
|
|
54
|
-
# `
|
|
52
|
+
# The routing header consists of one or multiple key-value pairs. The order of
|
|
53
|
+
# the key-value pairs is undefined, the order of the `routing_parameters` in
|
|
54
|
+
# the `RoutingRule` only matters for the evaluation order of the path
|
|
55
|
+
# templates when `field` is the same. See the examples below for more details.
|
|
56
|
+
#
|
|
57
|
+
# Every key and value in the routing header must be percent-encoded,
|
|
58
|
+
# and joined together in the following format: `key1=value1&key2=value2`.
|
|
55
59
|
# The examples below skip the percent-encoding for readability.
|
|
56
60
|
#
|
|
57
61
|
# Example 1
|
|
@@ -97,17 +97,29 @@ module Google
|
|
|
97
97
|
# The TTL (time-to-live) configuration for documents that have this `Field`
|
|
98
98
|
# set.
|
|
99
99
|
#
|
|
100
|
-
#
|
|
101
|
-
# the document
|
|
102
|
-
# the timestamp value
|
|
103
|
-
# TTL-enabled field.
|
|
100
|
+
# A timestamp stored in a TTL-enabled field will be used to determine the
|
|
101
|
+
# expiration time of the document. The expiration time is the sum
|
|
102
|
+
# of the timestamp value and the `expiration_offset`.
|
|
104
103
|
#
|
|
105
|
-
#
|
|
104
|
+
# For Enterprise edition databases, the timestamp value may alternatively be
|
|
105
|
+
# stored in an array value in the TTL-enabled field.
|
|
106
|
+
#
|
|
107
|
+
# An expiration time in the past indicates that the document is eligible for
|
|
106
108
|
# immediate expiration. Using any other data type or leaving the field absent
|
|
107
109
|
# will disable expiration for the individual document.
|
|
108
110
|
# @!attribute [r] state
|
|
109
111
|
# @return [::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State]
|
|
110
112
|
# Output only. The state of the TTL configuration.
|
|
113
|
+
# @!attribute [rw] expiration_offset
|
|
114
|
+
# @return [::Google::Protobuf::Duration]
|
|
115
|
+
# Optional. The offset, relative to the timestamp value from the
|
|
116
|
+
# TTL-enabled field, used to determine the document's expiration time.
|
|
117
|
+
#
|
|
118
|
+
# `expiration_offset.seconds` must be between 0 and 2,147,483,647
|
|
119
|
+
# inclusive. Values more precise than seconds are rejected.
|
|
120
|
+
#
|
|
121
|
+
# If unset, defaults to 0, in which case the expiration time is the same
|
|
122
|
+
# as the timestamp value from the TTL-enabled field.
|
|
111
123
|
class TtlConfig
|
|
112
124
|
include ::Google::Protobuf::MessageExts
|
|
113
125
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -113,6 +113,10 @@ module Google
|
|
|
113
113
|
# @!attribute [rw] change_type
|
|
114
114
|
# @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
|
|
115
115
|
# Specifies how the TTL configuration is changing.
|
|
116
|
+
# @!attribute [rw] expiration_offset
|
|
117
|
+
# @return [::Google::Protobuf::Duration]
|
|
118
|
+
# The offset, relative to the timestamp value in the TTL-enabled field,
|
|
119
|
+
# used determine the document's expiration time.
|
|
116
120
|
class TtlConfigDelta
|
|
117
121
|
include ::Google::Protobuf::MessageExts
|
|
118
122
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|