google-cloud-firestore-admin-v1 1.12.1 → 1.13.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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bf122a810c93f7f3f1de014a0aae577f7427c7779ae88724e6a08ff6a50bd3a9
|
|
4
|
+
data.tar.gz: ac1aa3b82204a14b2ae8feb6537415342d6efc3757fbeab62006f8598f651b4c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5f9c33a1888bbe6c26c10d81bca4b81cf0e2ea21dccee7fb865223a234b21a1ff6d4c82dc8fd286ec17c2fac7a88fab820626a4c018bf59be07c6b2d33bc1d70
|
|
7
|
+
data.tar.gz: '04823af258cb7e75357a38a2ec2155f717d6cd5a64606aae9613c9339b11d9b57d4b12bb79691bc046ed3d12d0e4b7d8d8ee9693e2c57d6cfc5bfd39cdee3e2b'
|
|
@@ -8,7 +8,7 @@ require 'google/api/field_behavior_pb'
|
|
|
8
8
|
require 'google/api/resource_pb'
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
descriptor_data = "\n%google/firestore/admin/v1/index.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\
|
|
11
|
+
descriptor_data = "\n%google/firestore/admin/v1/index.proto\x12\x19google.firestore.admin.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\"\xf5\x12\n\x05Index\x12\x0c\n\x04name\x18\x01 \x01(\t\x12@\n\x0bquery_scope\x18\x02 \x01(\x0e\x32+.google.firestore.admin.v1.Index.QueryScope\x12<\n\tapi_scope\x18\x05 \x01(\x0e\x32).google.firestore.admin.v1.Index.ApiScope\x12;\n\x06\x66ields\x18\x03 \x03(\x0b\x32+.google.firestore.admin.v1.Index.IndexField\x12\x35\n\x05state\x18\x04 \x01(\x0e\x32&.google.firestore.admin.v1.Index.State\x12>\n\x07\x64\x65nsity\x18\x06 \x01(\x0e\x32(.google.firestore.admin.v1.Index.DensityB\x03\xe0\x41\x05\x12\x15\n\x08multikey\x18\x07 \x01(\x08\x42\x03\xe0\x41\x01\x12\x18\n\x0bshard_count\x18\x08 \x01(\x05\x42\x03\xe0\x41\x01\x12\x13\n\x06unique\x18\n \x01(\x08\x42\x03\xe0\x41\x01\x12V\n\x14search_index_options\x18\t \x01(\x0b\x32\x33.google.firestore.admin.v1.Index.SearchIndexOptionsB\x03\xe0\x41\x01\x1a\xdb\n\n\nIndexField\x12\x12\n\nfield_path\x18\x01 \x01(\t\x12\x42\n\x05order\x18\x02 \x01(\x0e\x32\x31.google.firestore.admin.v1.Index.IndexField.OrderH\x00\x12O\n\x0c\x61rray_config\x18\x03 \x01(\x0e\x32\x37.google.firestore.admin.v1.Index.IndexField.ArrayConfigH\x00\x12Q\n\rvector_config\x18\x04 \x01(\x0b\x32\x38.google.firestore.admin.v1.Index.IndexField.VectorConfigH\x00\x12Q\n\rsearch_config\x18\x05 \x01(\x0b\x32\x38.google.firestore.admin.v1.Index.IndexField.SearchConfigH\x00\x1a\x8f\x01\n\x0cVectorConfig\x12\x16\n\tdimension\x18\x01 \x01(\x05\x42\x03\xe0\x41\x02\x12R\n\x04\x66lat\x18\x02 \x01(\x0b\x32\x42.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndexH\x00\x1a\x0b\n\tFlatIndexB\x06\n\x04type\x1a\xe3\x05\n\x0cSearchConfig\x12_\n\ttext_spec\x18\x01 \x01(\x0b\x32G.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextSpecB\x03\xe0\x41\x01\x12]\n\x08geo_spec\x18\x02 \x01(\x0b\x32\x46.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchGeoSpecB\x03\xe0\x41\x01\x1a\xd7\x01\n\x13SearchTextIndexSpec\x12_\n\nindex_type\x18\x01 \x01(\x0e\x32\x46.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextIndexTypeB\x03\xe0\x41\x02\x12_\n\nmatch_type\x18\x02 \x01(\x0e\x32\x46.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextMatchTypeB\x03\xe0\x41\x02\x1ax\n\x0eSearchTextSpec\x12\x66\n\x0bindex_specs\x18\x01 \x03(\x0b\x32L.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpecB\x03\xe0\x41\x02\x1a\x38\n\rSearchGeoSpec\x12\'\n\x1ageo_json_indexing_disabled\x18\x01 \x01(\x08\x42\x03\xe0\x41\x01\"?\n\rTextIndexType\x12\x1f\n\x1bTEXT_INDEX_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tTOKENIZED\x10\x01\"D\n\rTextMatchType\x12\x1f\n\x1bTEXT_MATCH_TYPE_UNSPECIFIED\x10\x00\x12\x12\n\x0eMATCH_GLOBALLY\x10\x01\"=\n\x05Order\x12\x15\n\x11ORDER_UNSPECIFIED\x10\x00\x12\r\n\tASCENDING\x10\x01\x12\x0e\n\nDESCENDING\x10\x02\"9\n\x0b\x41rrayConfig\x12\x1c\n\x18\x41RRAY_CONFIG_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43ONTAINS\x10\x01\x42\x0c\n\nvalue_mode\x1a`\n\x12SearchIndexOptions\x12\x1a\n\rtext_language\x18\x01 \x01(\tB\x03\xe0\x41\x01\x12.\n!text_language_override_field_path\x18\x02 \x01(\tB\x03\xe0\x41\x01\"i\n\nQueryScope\x12\x1b\n\x17QUERY_SCOPE_UNSPECIFIED\x10\x00\x12\x0e\n\nCOLLECTION\x10\x01\x12\x14\n\x10\x43OLLECTION_GROUP\x10\x02\x12\x18\n\x14\x43OLLECTION_RECURSIVE\x10\x03\"K\n\x08\x41piScope\x12\x0b\n\x07\x41NY_API\x10\x00\x12\x16\n\x12\x44\x41TASTORE_MODE_API\x10\x01\x12\x1a\n\x16MONGODB_COMPATIBLE_API\x10\x02\"I\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43REATING\x10\x01\x12\t\n\x05READY\x10\x02\x12\x10\n\x0cNEEDS_REPAIR\x10\x03\"M\n\x07\x44\x65nsity\x12\x17\n\x13\x44\x45NSITY_UNSPECIFIED\x10\x00\x12\x0e\n\nSPARSE_ALL\x10\x01\x12\x0e\n\nSPARSE_ANY\x10\x02\x12\t\n\x05\x44\x45NSE\x10\x03:z\xea\x41w\n\x1e\x66irestore.googleapis.com/Index\x12Uprojects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}B\xd9\x01\n\x1d\x63om.google.firestore.admin.v1B\nIndexProtoP\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
12
|
|
|
13
13
|
pool = ::Google::Protobuf::DescriptorPool.generated_pool
|
|
14
14
|
pool.add_serialized_file(descriptor_data)
|
|
@@ -22,8 +22,15 @@ module Google
|
|
|
22
22
|
Index::IndexField = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField").msgclass
|
|
23
23
|
Index::IndexField::VectorConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.VectorConfig").msgclass
|
|
24
24
|
Index::IndexField::VectorConfig::FlatIndex = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex").msgclass
|
|
25
|
+
Index::IndexField::SearchConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.SearchConfig").msgclass
|
|
26
|
+
Index::IndexField::SearchConfig::SearchTextIndexSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec").msgclass
|
|
27
|
+
Index::IndexField::SearchConfig::SearchTextSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextSpec").msgclass
|
|
28
|
+
Index::IndexField::SearchConfig::SearchGeoSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchGeoSpec").msgclass
|
|
29
|
+
Index::IndexField::SearchConfig::TextIndexType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.SearchConfig.TextIndexType").enummodule
|
|
30
|
+
Index::IndexField::SearchConfig::TextMatchType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.SearchConfig.TextMatchType").enummodule
|
|
25
31
|
Index::IndexField::Order = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.Order").enummodule
|
|
26
32
|
Index::IndexField::ArrayConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.ArrayConfig").enummodule
|
|
33
|
+
Index::SearchIndexOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.SearchIndexOptions").msgclass
|
|
27
34
|
Index::QueryScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.QueryScope").enummodule
|
|
28
35
|
Index::ApiScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.ApiScope").enummodule
|
|
29
36
|
Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.State").enummodule
|
|
@@ -31,6 +31,11 @@ module Google
|
|
|
31
31
|
# Output only. The unique resource name of the Backup.
|
|
32
32
|
#
|
|
33
33
|
# Format is `projects/{project}/locations/{location}/backups/{backup}`.
|
|
34
|
+
#
|
|
35
|
+
# The location in the name will be the Standard Managed Multi-Region (SMMR)
|
|
36
|
+
# location (e.g. `us`) if the backup was created with an SMMR location, or
|
|
37
|
+
# the Google Managed Multi-Region (GMMR) location (e.g. `nam5`) if the backup
|
|
38
|
+
# was created with a GMMR location.
|
|
34
39
|
# @!attribute [r] database
|
|
35
40
|
# @return [::String]
|
|
36
41
|
# Output only. Name of the Firestore database that the backup is from.
|
|
@@ -78,6 +78,11 @@ module Google
|
|
|
78
78
|
# @return [::Boolean]
|
|
79
79
|
# Optional. Whether it is an unique index. Unique index ensures all values
|
|
80
80
|
# for the indexed field(s) are unique across documents.
|
|
81
|
+
# @!attribute [rw] search_index_options
|
|
82
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::SearchIndexOptions]
|
|
83
|
+
# Optional. Options for search indexes that are at the index definition
|
|
84
|
+
# level. This field is only currently supported for indexes with
|
|
85
|
+
# MONGODB_COMPATIBLE_API ApiScope.
|
|
81
86
|
class Index
|
|
82
87
|
include ::Google::Protobuf::MessageExts
|
|
83
88
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -95,18 +100,25 @@ module Google
|
|
|
95
100
|
# Indicates that this field supports ordering by the specified order or
|
|
96
101
|
# comparing using =, !=, <, <=, >, >=.
|
|
97
102
|
#
|
|
98
|
-
# Note: The following fields are mutually exclusive: `order`, `array_config`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
103
|
+
# Note: The following fields are mutually exclusive: `order`, `array_config`, `vector_config`, `search_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
99
104
|
# @!attribute [rw] array_config
|
|
100
105
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
|
|
101
106
|
# Indicates that this field supports operations on `array_value`s.
|
|
102
107
|
#
|
|
103
|
-
# Note: The following fields are mutually exclusive: `array_config`, `order`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
108
|
+
# Note: The following fields are mutually exclusive: `array_config`, `order`, `vector_config`, `search_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
104
109
|
# @!attribute [rw] vector_config
|
|
105
110
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig]
|
|
106
111
|
# Indicates that this field supports nearest neighbor and distance
|
|
107
112
|
# operations on vector.
|
|
108
113
|
#
|
|
109
|
-
# Note: The following fields are mutually exclusive: `vector_config`, `order`, `array_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
114
|
+
# Note: The following fields are mutually exclusive: `vector_config`, `order`, `array_config`, `search_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
115
|
+
# @!attribute [rw] search_config
|
|
116
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig]
|
|
117
|
+
# Indicates that this field supports search operations. This field
|
|
118
|
+
# is only currently supported for indexes with MONGODB_COMPATIBLE_API
|
|
119
|
+
# ApiScope.
|
|
120
|
+
#
|
|
121
|
+
# Note: The following fields are mutually exclusive: `search_config`, `order`, `array_config`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
110
122
|
class IndexField
|
|
111
123
|
include ::Google::Protobuf::MessageExts
|
|
112
124
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -133,6 +145,74 @@ module Google
|
|
|
133
145
|
end
|
|
134
146
|
end
|
|
135
147
|
|
|
148
|
+
# The configuration for how to index a field for search.
|
|
149
|
+
# @!attribute [rw] text_spec
|
|
150
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::SearchTextSpec]
|
|
151
|
+
# Optional. The specification for building a text search index for a
|
|
152
|
+
# field.
|
|
153
|
+
# @!attribute [rw] geo_spec
|
|
154
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::SearchGeoSpec]
|
|
155
|
+
# Optional. The specification for building a geo search index for a
|
|
156
|
+
# field.
|
|
157
|
+
class SearchConfig
|
|
158
|
+
include ::Google::Protobuf::MessageExts
|
|
159
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
160
|
+
|
|
161
|
+
# Specification of how the field should be indexed for search text
|
|
162
|
+
# indexes.
|
|
163
|
+
# @!attribute [rw] index_type
|
|
164
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextIndexType]
|
|
165
|
+
# Required. How to index the text field value.
|
|
166
|
+
# @!attribute [rw] match_type
|
|
167
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::TextMatchType]
|
|
168
|
+
# Required. How to match the text field value.
|
|
169
|
+
class SearchTextIndexSpec
|
|
170
|
+
include ::Google::Protobuf::MessageExts
|
|
171
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# The specification for how to build a text search index for a field.
|
|
175
|
+
# @!attribute [rw] index_specs
|
|
176
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig::SearchTextIndexSpec>]
|
|
177
|
+
# Required. Specifications for how the field should be indexed.
|
|
178
|
+
# Repeated so that the field can be indexed in multiple ways.
|
|
179
|
+
class SearchTextSpec
|
|
180
|
+
include ::Google::Protobuf::MessageExts
|
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
# The specification for how to build a geo search index for a field.
|
|
185
|
+
# @!attribute [rw] geo_json_indexing_disabled
|
|
186
|
+
# @return [::Boolean]
|
|
187
|
+
# Optional. Disables geoJSON indexing for the field. By default,
|
|
188
|
+
# geoJSON points are indexed.
|
|
189
|
+
class SearchGeoSpec
|
|
190
|
+
include ::Google::Protobuf::MessageExts
|
|
191
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
# Ways to index the text field value.
|
|
195
|
+
module TextIndexType
|
|
196
|
+
# The index type is unspecified. Not a valid option.
|
|
197
|
+
TEXT_INDEX_TYPE_UNSPECIFIED = 0
|
|
198
|
+
|
|
199
|
+
# Field values are tokenized. This is the only way currently supported
|
|
200
|
+
# for MONGODB_COMPATIBLE_API.
|
|
201
|
+
TOKENIZED = 1
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
# Types of text matches that are supported for the
|
|
205
|
+
# field.
|
|
206
|
+
module TextMatchType
|
|
207
|
+
# The match type is unspecified. Not a valid option.
|
|
208
|
+
TEXT_MATCH_TYPE_UNSPECIFIED = 0
|
|
209
|
+
|
|
210
|
+
# Match on any indexed field. This is the only way currently supported
|
|
211
|
+
# for MONGODB_COMPATIBLE_API.
|
|
212
|
+
MATCH_GLOBALLY = 1
|
|
213
|
+
end
|
|
214
|
+
end
|
|
215
|
+
|
|
136
216
|
# The supported orderings.
|
|
137
217
|
module Order
|
|
138
218
|
# The ordering is unspecified. Not a valid option.
|
|
@@ -155,6 +235,28 @@ module Google
|
|
|
155
235
|
end
|
|
156
236
|
end
|
|
157
237
|
|
|
238
|
+
# Options for search indexes at the definition level.
|
|
239
|
+
# @!attribute [rw] text_language
|
|
240
|
+
# @return [::String]
|
|
241
|
+
# Optional. The language to use for text search indexes. Used as the
|
|
242
|
+
# default language if not overridden at the document level by specifying
|
|
243
|
+
# the `text_language_override_field`. The language is specified as a BCP 47
|
|
244
|
+
# language code.
|
|
245
|
+
# For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the
|
|
246
|
+
# default language is English.
|
|
247
|
+
# For indexes with `ANY_API` ApiScope: If unspecified, the default behavior
|
|
248
|
+
# is autodetect.
|
|
249
|
+
# @!attribute [rw] text_language_override_field_path
|
|
250
|
+
# @return [::String]
|
|
251
|
+
# Optional. The field in the document that specifies which language to use
|
|
252
|
+
# for that specific document. For indexes with MONGODB_COMPATIBLE_API
|
|
253
|
+
# ApiScope: if unspecified, the language is taken from the "language" field
|
|
254
|
+
# if it exists or from `text_language` if it does not.
|
|
255
|
+
class SearchIndexOptions
|
|
256
|
+
include ::Google::Protobuf::MessageExts
|
|
257
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
258
|
+
end
|
|
259
|
+
|
|
158
260
|
# Query Scope defines the scope at which a query is run. This is specified on
|
|
159
261
|
# a StructuredQuery's `from` field.
|
|
160
262
|
module QueryScope
|