google-cloud-firestore-admin-v1 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +2 -2
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +2 -2
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/client.rb +2 -2
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb +2 -2
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/index_pb.rb +7 -0
- data/proto_docs/google/api/client.rb +67 -4
- data/proto_docs/google/firestore/admin/v1/index.rb +24 -6
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 44272042c309e5302eec5551cd6a25645a0b73d4cc0beec3f9adf8670bb41248
|
4
|
+
data.tar.gz: 2d6525b835a1fa295c255479e83f4212aa309dd3427178109d7aa49bd71dcaf4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f033088ffadc96e0ad1ab201745f0b16656bf799ac926afc7d9239aa4c1ce5097f41adf73de2a7a005381af6393da8680b525a4a7c57955f6af205de37a4e5d6
|
7
|
+
data.tar.gz: cea92f85b56fde40ef31de9a3a9f6282cc9bd7680b812638e88f9b842c3a7b3c505de6b15847c679679604cc008d8db2a045e1ad0b1eec317b20870a6a587f47
|
data/README.md
CHANGED
@@ -47,7 +47,7 @@ for general usage information.
|
|
47
47
|
|
48
48
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
49
49
|
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
50
|
-
or a [`Google::Cloud::Logging::Logger`](https://
|
50
|
+
or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
|
51
51
|
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
52
52
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
53
53
|
|
@@ -1430,9 +1430,9 @@ module Google
|
|
1430
1430
|
# * (`String`) The path to a service account key file in JSON format
|
1431
1431
|
# * (`Hash`) A service account key as a Hash
|
1432
1432
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
1433
|
-
# (see the [googleauth docs](https://
|
1433
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
1434
1434
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1435
|
-
# (see the [signet docs](https://
|
1435
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
1436
1436
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
1437
1437
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
1438
1438
|
# * (`nil`) indicating no credentials
|
@@ -621,9 +621,9 @@ module Google
|
|
621
621
|
# * (`String`) The path to a service account key file in JSON format
|
622
622
|
# * (`Hash`) A service account key as a Hash
|
623
623
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
624
|
-
# (see the [googleauth docs](https://
|
624
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
625
625
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
626
|
-
# (see the [signet docs](https://
|
626
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
627
627
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
628
628
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
629
629
|
# * (`nil`) indicating no credentials
|
@@ -1102,9 +1102,9 @@ module Google
|
|
1102
1102
|
# * (`String`) The path to a service account key file in JSON format
|
1103
1103
|
# * (`Hash`) A service account key as a Hash
|
1104
1104
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
1105
|
-
# (see the [googleauth docs](https://
|
1105
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
1106
1106
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1107
|
-
# (see the [signet docs](https://
|
1107
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
1108
1108
|
# * (`nil`) indicating no credentials
|
1109
1109
|
# @return [::Object]
|
1110
1110
|
# @!attribute [rw] scope
|
@@ -412,9 +412,9 @@ module Google
|
|
412
412
|
# * (`String`) The path to a service account key file in JSON format
|
413
413
|
# * (`Hash`) A service account key as a Hash
|
414
414
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
415
|
-
# (see the [googleauth docs](https://
|
415
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
416
416
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
417
|
-
# (see the [signet docs](https://
|
417
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
418
418
|
# * (`nil`) indicating no credentials
|
419
419
|
# @return [::Object]
|
420
420
|
# @!attribute [rw] scope
|
@@ -10,6 +10,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
10
10
|
add_message "google.firestore.admin.v1.Index" do
|
11
11
|
optional :name, :string, 1
|
12
12
|
optional :query_scope, :enum, 2, "google.firestore.admin.v1.Index.QueryScope"
|
13
|
+
optional :api_scope, :enum, 5, "google.firestore.admin.v1.Index.ApiScope"
|
13
14
|
repeated :fields, :message, 3, "google.firestore.admin.v1.Index.IndexField"
|
14
15
|
optional :state, :enum, 4, "google.firestore.admin.v1.Index.State"
|
15
16
|
end
|
@@ -33,6 +34,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
33
34
|
value :QUERY_SCOPE_UNSPECIFIED, 0
|
34
35
|
value :COLLECTION, 1
|
35
36
|
value :COLLECTION_GROUP, 2
|
37
|
+
value :COLLECTION_RECURSIVE, 3
|
38
|
+
end
|
39
|
+
add_enum "google.firestore.admin.v1.Index.ApiScope" do
|
40
|
+
value :ANY_API, 0
|
41
|
+
value :DATASTORE_MODE_API, 1
|
36
42
|
end
|
37
43
|
add_enum "google.firestore.admin.v1.Index.State" do
|
38
44
|
value :STATE_UNSPECIFIED, 0
|
@@ -53,6 +59,7 @@ module Google
|
|
53
59
|
Index::IndexField::Order = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.Order").enummodule
|
54
60
|
Index::IndexField::ArrayConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.ArrayConfig").enummodule
|
55
61
|
Index::QueryScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.QueryScope").enummodule
|
62
|
+
Index::ApiScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.ApiScope").enummodule
|
56
63
|
Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.State").enummodule
|
57
64
|
end
|
58
65
|
end
|
@@ -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?
|
@@ -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
|
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.9.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-05-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|