google-cloud-firestore-admin-v1 0.3.5 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +321 -3
- data/lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb +14 -0
- data/lib/google/cloud/firestore/admin/v1/firestore_admin.rb +26 -0
- data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
- data/lib/google/firestore/admin/v1/database_pb.rb +46 -0
- data/lib/google/firestore/admin/v1/field_pb.rb +1 -0
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +23 -0
- data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb +37 -3
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/firestore/admin/v1/database.rb +91 -0
- data/proto_docs/google/firestore/admin/v1/field.rb +1 -1
- data/proto_docs/google/firestore/admin/v1/firestore_admin.rb +49 -2
- data/proto_docs/google/firestore/admin/v1/index.rb +1 -1
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 57ac7b3785adf8f1e43707d5450e8d806780aa70aae7089d25ac8d774312aec5
|
4
|
+
data.tar.gz: b545276711f57102c05622117accef8064cf094c2779d432a41a0927dba3ab80
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9f0d68dd51a8c96be02be5f197dae2440c07231fe17cf28d0c116f9b990ca97d11e4c1614a5ea453af69f4865a4333b98333a1c8bda5d2881235c7835ae3ac83
|
7
|
+
data.tar.gz: 9b04fa863bb15308224ea4c6aea035116da46c5db6362da95dcb89f2fef0ee91ea7a51f9d0480bca168ab48358a93c90627244e120c871203b688d29518078a0
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
121
|
*should* only be used during development.
|
122
122
|
|
123
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
124
|
-
[dev-console]: https://console.cloud.google.com/project
|
125
|
-
|
126
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
127
|
-
|
128
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
129
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
130
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
131
|
-
|
132
123
|
## Creating a Service Account
|
133
124
|
|
134
125
|
Google Cloud requires **Service Account Credentials** to
|
@@ -139,31 +130,22 @@ If you are not running this client within
|
|
139
130
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
131
|
need a Google Developers service account.
|
141
132
|
|
142
|
-
1. Visit the [Google
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
143
134
|
2. Create a new project or click on an existing project.
|
144
|
-
3. Activate the
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
145
136
|
here, you will enable the APIs that your application requires.
|
146
137
|
|
147
|
-
![Enable the APIs that your application requires][enable-apis]
|
148
|
-
|
149
138
|
*Note: You may need to enable billing in order to use these services.*
|
150
139
|
|
151
140
|
4. Select **Credentials** from the side navigation.
|
152
141
|
|
153
|
-
|
154
|
-
|
155
|
-
![Create a new service account][create-new-service-account]
|
156
|
-
|
157
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
158
|
-
|
159
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
160
|
-
guided through downloading a new JSON key file.
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
161
144
|
|
162
145
|
If you want to re-use an existing service account, you can easily generate a
|
163
|
-
new key file. Just select the account you wish to re-use,
|
164
|
-
|
165
|
-
|
166
|
-
![Re-use an existing service account][reuse-service-account]
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
+
and then select **Add Key**.
|
167
149
|
|
168
150
|
The key file you download will be used by this library to authenticate API
|
169
151
|
requests and should be stored in a secure location.
|
@@ -28,6 +28,32 @@ module Google
|
|
28
28
|
##
|
29
29
|
# Client for the FirestoreAdmin service.
|
30
30
|
#
|
31
|
+
# The Cloud Firestore Admin API.
|
32
|
+
#
|
33
|
+
# This API provides several administrative services for Cloud Firestore.
|
34
|
+
#
|
35
|
+
# Project, Database, Namespace, Collection, Collection Group, and Document are
|
36
|
+
# used as defined in the Google Cloud Firestore API.
|
37
|
+
#
|
38
|
+
# Operation: An Operation represents work being performed in the background.
|
39
|
+
#
|
40
|
+
# The index service manages Cloud Firestore indexes.
|
41
|
+
#
|
42
|
+
# Index creation is performed asynchronously.
|
43
|
+
# An Operation resource is created for each such asynchronous operation.
|
44
|
+
# The state of the operation (including any errors encountered)
|
45
|
+
# may be queried via the Operation resource.
|
46
|
+
#
|
47
|
+
# The Operations collection provides a record of actions performed for the
|
48
|
+
# specified Project (including any Operations in progress). Operations are not
|
49
|
+
# created directly but through calls on other collections or resources.
|
50
|
+
#
|
51
|
+
# An Operation that is done may be deleted so that it is no longer listed as
|
52
|
+
# part of the Operation collection. Operations are garbage collected after
|
53
|
+
# 30 days. By default, ListOperations will only return in progress and failed
|
54
|
+
# operations. To list completed operation, issue a ListOperations request with
|
55
|
+
# the filter `done: true`.
|
56
|
+
#
|
31
57
|
# Operations are created by service `FirestoreAdmin`, but are accessed via
|
32
58
|
# service `google.longrunning.Operations`.
|
33
59
|
#
|
@@ -170,6 +196,7 @@ module Google
|
|
170
196
|
|
171
197
|
@operations_client = Operations.new do |config|
|
172
198
|
config.credentials = credentials
|
199
|
+
config.quota_project = @quota_project_id
|
173
200
|
config.endpoint = @config.endpoint
|
174
201
|
end
|
175
202
|
|
@@ -762,7 +789,7 @@ module Google
|
|
762
789
|
# Currently, {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
|
763
790
|
# that have been explicitly overridden. To issue this query, call
|
764
791
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
|
765
|
-
# `indexConfig.usesAncestorConfig:false
|
792
|
+
# `indexConfig.usesAncestorConfig:false` .
|
766
793
|
#
|
767
794
|
# @overload list_fields(request, options = nil)
|
768
795
|
# Pass arguments to `list_fields` via a request object, either of type
|
@@ -786,8 +813,8 @@ module Google
|
|
786
813
|
# The filter to apply to list results. Currently,
|
787
814
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
|
788
815
|
# that have been explicitly overridden. To issue this query, call
|
789
|
-
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with
|
790
|
-
# `indexConfig.usesAncestorConfig:false
|
816
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with a filter that includes
|
817
|
+
# `indexConfig.usesAncestorConfig:false` .
|
791
818
|
# @param page_size [::Integer]
|
792
819
|
# The number of results to return.
|
793
820
|
# @param page_token [::String]
|
@@ -876,6 +903,9 @@ module Google
|
|
876
903
|
# cancelled before completion it may leave partial data behind in Google
|
877
904
|
# Cloud Storage.
|
878
905
|
#
|
906
|
+
# For more details on export behavior and output format, refer to:
|
907
|
+
# https://cloud.google.com/firestore/docs/manage-data/export-import
|
908
|
+
#
|
879
909
|
# @overload export_documents(request, options = nil)
|
880
910
|
# Pass arguments to `export_documents` via a request object, either of type
|
881
911
|
# {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest} or an equivalent Hash.
|
@@ -1085,6 +1115,273 @@ module Google
|
|
1085
1115
|
raise ::Google::Cloud::Error.from_error(e)
|
1086
1116
|
end
|
1087
1117
|
|
1118
|
+
##
|
1119
|
+
# Gets information about a database.
|
1120
|
+
#
|
1121
|
+
# @overload get_database(request, options = nil)
|
1122
|
+
# Pass arguments to `get_database` via a request object, either of type
|
1123
|
+
# {::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest} or an equivalent Hash.
|
1124
|
+
#
|
1125
|
+
# @param request [::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest, ::Hash]
|
1126
|
+
# A request object representing the call parameters. Required. To specify no
|
1127
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1128
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1129
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1130
|
+
#
|
1131
|
+
# @overload get_database(name: nil)
|
1132
|
+
# Pass arguments to `get_database` via keyword arguments. Note that at
|
1133
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1134
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1135
|
+
#
|
1136
|
+
# @param name [::String]
|
1137
|
+
# Required. A name of the form
|
1138
|
+
# `projects/{project_id}/databases/{database_id}`
|
1139
|
+
#
|
1140
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1141
|
+
# @yieldparam response [::Google::Cloud::Firestore::Admin::V1::Database]
|
1142
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1143
|
+
#
|
1144
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
|
1145
|
+
#
|
1146
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1147
|
+
#
|
1148
|
+
# @example Basic example
|
1149
|
+
# require "google/cloud/firestore/admin/v1"
|
1150
|
+
#
|
1151
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1152
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
|
1153
|
+
#
|
1154
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1155
|
+
# request = Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest.new
|
1156
|
+
#
|
1157
|
+
# # Call the get_database method.
|
1158
|
+
# result = client.get_database request
|
1159
|
+
#
|
1160
|
+
# # The returned object is of type Google::Cloud::Firestore::Admin::V1::Database.
|
1161
|
+
# p result
|
1162
|
+
#
|
1163
|
+
def get_database request, options = nil
|
1164
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1165
|
+
|
1166
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest
|
1167
|
+
|
1168
|
+
# Converts hash and nil to an options object
|
1169
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1170
|
+
|
1171
|
+
# Customize the options with defaults
|
1172
|
+
metadata = @config.rpcs.get_database.metadata.to_h
|
1173
|
+
|
1174
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1175
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1176
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1177
|
+
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
1178
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1179
|
+
|
1180
|
+
header_params = {}
|
1181
|
+
if request.name
|
1182
|
+
header_params["name"] = request.name
|
1183
|
+
end
|
1184
|
+
|
1185
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1186
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1187
|
+
|
1188
|
+
options.apply_defaults timeout: @config.rpcs.get_database.timeout,
|
1189
|
+
metadata: metadata,
|
1190
|
+
retry_policy: @config.rpcs.get_database.retry_policy
|
1191
|
+
|
1192
|
+
options.apply_defaults timeout: @config.timeout,
|
1193
|
+
metadata: @config.metadata,
|
1194
|
+
retry_policy: @config.retry_policy
|
1195
|
+
|
1196
|
+
@firestore_admin_stub.call_rpc :get_database, request, options: options do |response, operation|
|
1197
|
+
yield response, operation if block_given?
|
1198
|
+
return response
|
1199
|
+
end
|
1200
|
+
rescue ::GRPC::BadStatus => e
|
1201
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1202
|
+
end
|
1203
|
+
|
1204
|
+
##
|
1205
|
+
# List all the databases in the project.
|
1206
|
+
#
|
1207
|
+
# @overload list_databases(request, options = nil)
|
1208
|
+
# Pass arguments to `list_databases` via a request object, either of type
|
1209
|
+
# {::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest} or an equivalent Hash.
|
1210
|
+
#
|
1211
|
+
# @param request [::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest, ::Hash]
|
1212
|
+
# A request object representing the call parameters. Required. To specify no
|
1213
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1214
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1215
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1216
|
+
#
|
1217
|
+
# @overload list_databases(parent: nil)
|
1218
|
+
# Pass arguments to `list_databases` via keyword arguments. Note that at
|
1219
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1220
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1221
|
+
#
|
1222
|
+
# @param parent [::String]
|
1223
|
+
# Required. A parent name of the form
|
1224
|
+
# `projects/{project_id}`
|
1225
|
+
#
|
1226
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1227
|
+
# @yieldparam response [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
|
1228
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1229
|
+
#
|
1230
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
|
1231
|
+
#
|
1232
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1233
|
+
#
|
1234
|
+
# @example Basic example
|
1235
|
+
# require "google/cloud/firestore/admin/v1"
|
1236
|
+
#
|
1237
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1238
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
|
1239
|
+
#
|
1240
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1241
|
+
# request = Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest.new
|
1242
|
+
#
|
1243
|
+
# # Call the list_databases method.
|
1244
|
+
# result = client.list_databases request
|
1245
|
+
#
|
1246
|
+
# # The returned object is of type Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse.
|
1247
|
+
# p result
|
1248
|
+
#
|
1249
|
+
def list_databases request, options = nil
|
1250
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1251
|
+
|
1252
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest
|
1253
|
+
|
1254
|
+
# Converts hash and nil to an options object
|
1255
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1256
|
+
|
1257
|
+
# Customize the options with defaults
|
1258
|
+
metadata = @config.rpcs.list_databases.metadata.to_h
|
1259
|
+
|
1260
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1261
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1262
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1263
|
+
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
1264
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1265
|
+
|
1266
|
+
header_params = {}
|
1267
|
+
if request.parent
|
1268
|
+
header_params["parent"] = request.parent
|
1269
|
+
end
|
1270
|
+
|
1271
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1272
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1273
|
+
|
1274
|
+
options.apply_defaults timeout: @config.rpcs.list_databases.timeout,
|
1275
|
+
metadata: metadata,
|
1276
|
+
retry_policy: @config.rpcs.list_databases.retry_policy
|
1277
|
+
|
1278
|
+
options.apply_defaults timeout: @config.timeout,
|
1279
|
+
metadata: @config.metadata,
|
1280
|
+
retry_policy: @config.retry_policy
|
1281
|
+
|
1282
|
+
@firestore_admin_stub.call_rpc :list_databases, request, options: options do |response, operation|
|
1283
|
+
yield response, operation if block_given?
|
1284
|
+
return response
|
1285
|
+
end
|
1286
|
+
rescue ::GRPC::BadStatus => e
|
1287
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1288
|
+
end
|
1289
|
+
|
1290
|
+
##
|
1291
|
+
# Updates a database.
|
1292
|
+
#
|
1293
|
+
# @overload update_database(request, options = nil)
|
1294
|
+
# Pass arguments to `update_database` via a request object, either of type
|
1295
|
+
# {::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest} or an equivalent Hash.
|
1296
|
+
#
|
1297
|
+
# @param request [::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest, ::Hash]
|
1298
|
+
# A request object representing the call parameters. Required. To specify no
|
1299
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1300
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1301
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1302
|
+
#
|
1303
|
+
# @overload update_database(database: nil, update_mask: nil)
|
1304
|
+
# Pass arguments to `update_database` via keyword arguments. Note that at
|
1305
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1306
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1307
|
+
#
|
1308
|
+
# @param database [::Google::Cloud::Firestore::Admin::V1::Database, ::Hash]
|
1309
|
+
# Required. The database to update.
|
1310
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1311
|
+
# The list of fields to be updated.
|
1312
|
+
#
|
1313
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1314
|
+
# @yieldparam response [::Gapic::Operation]
|
1315
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1316
|
+
#
|
1317
|
+
# @return [::Gapic::Operation]
|
1318
|
+
#
|
1319
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1320
|
+
#
|
1321
|
+
# @example Basic example
|
1322
|
+
# require "google/cloud/firestore/admin/v1"
|
1323
|
+
#
|
1324
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1325
|
+
# client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
|
1326
|
+
#
|
1327
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1328
|
+
# request = Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest.new
|
1329
|
+
#
|
1330
|
+
# # Call the update_database method.
|
1331
|
+
# result = client.update_database request
|
1332
|
+
#
|
1333
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
1334
|
+
# # object to check the status of an operation, cancel it, or wait
|
1335
|
+
# # for results. Here is how to block until completion:
|
1336
|
+
# result.wait_until_done! timeout: 60
|
1337
|
+
# if result.response?
|
1338
|
+
# p result.response
|
1339
|
+
# else
|
1340
|
+
# puts "Error!"
|
1341
|
+
# end
|
1342
|
+
#
|
1343
|
+
def update_database request, options = nil
|
1344
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1345
|
+
|
1346
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest
|
1347
|
+
|
1348
|
+
# Converts hash and nil to an options object
|
1349
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1350
|
+
|
1351
|
+
# Customize the options with defaults
|
1352
|
+
metadata = @config.rpcs.update_database.metadata.to_h
|
1353
|
+
|
1354
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1355
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1356
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1357
|
+
gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
|
1358
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1359
|
+
|
1360
|
+
header_params = {}
|
1361
|
+
if request.database&.name
|
1362
|
+
header_params["database.name"] = request.database.name
|
1363
|
+
end
|
1364
|
+
|
1365
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1366
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1367
|
+
|
1368
|
+
options.apply_defaults timeout: @config.rpcs.update_database.timeout,
|
1369
|
+
metadata: metadata,
|
1370
|
+
retry_policy: @config.rpcs.update_database.retry_policy
|
1371
|
+
|
1372
|
+
options.apply_defaults timeout: @config.timeout,
|
1373
|
+
metadata: @config.metadata,
|
1374
|
+
retry_policy: @config.retry_policy
|
1375
|
+
|
1376
|
+
@firestore_admin_stub.call_rpc :update_database, request, options: options do |response, operation|
|
1377
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
1378
|
+
yield response, operation if block_given?
|
1379
|
+
return response
|
1380
|
+
end
|
1381
|
+
rescue ::GRPC::BadStatus => e
|
1382
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1383
|
+
end
|
1384
|
+
|
1088
1385
|
##
|
1089
1386
|
# Configuration class for the FirestoreAdmin API.
|
1090
1387
|
#
|
@@ -1265,6 +1562,21 @@ module Google
|
|
1265
1562
|
# @return [::Gapic::Config::Method]
|
1266
1563
|
#
|
1267
1564
|
attr_reader :import_documents
|
1565
|
+
##
|
1566
|
+
# RPC-specific configuration for `get_database`
|
1567
|
+
# @return [::Gapic::Config::Method]
|
1568
|
+
#
|
1569
|
+
attr_reader :get_database
|
1570
|
+
##
|
1571
|
+
# RPC-specific configuration for `list_databases`
|
1572
|
+
# @return [::Gapic::Config::Method]
|
1573
|
+
#
|
1574
|
+
attr_reader :list_databases
|
1575
|
+
##
|
1576
|
+
# RPC-specific configuration for `update_database`
|
1577
|
+
# @return [::Gapic::Config::Method]
|
1578
|
+
#
|
1579
|
+
attr_reader :update_database
|
1268
1580
|
|
1269
1581
|
# @private
|
1270
1582
|
def initialize parent_rpcs = nil
|
@@ -1286,6 +1598,12 @@ module Google
|
|
1286
1598
|
@export_documents = ::Gapic::Config::Method.new export_documents_config
|
1287
1599
|
import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
|
1288
1600
|
@import_documents = ::Gapic::Config::Method.new import_documents_config
|
1601
|
+
get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
|
1602
|
+
@get_database = ::Gapic::Config::Method.new get_database_config
|
1603
|
+
list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
|
1604
|
+
@list_databases = ::Gapic::Config::Method.new list_databases_config
|
1605
|
+
update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
|
1606
|
+
@update_database = ::Gapic::Config::Method.new update_database_config
|
1289
1607
|
|
1290
1608
|
yield self if block_given?
|
1291
1609
|
end
|
@@ -103,6 +103,20 @@ module Google
|
|
103
103
|
"projects/#{project}/databases/#{database}/collectionGroups/#{collection}/indexes/#{index}"
|
104
104
|
end
|
105
105
|
|
106
|
+
##
|
107
|
+
# Create a fully-qualified Project resource string.
|
108
|
+
#
|
109
|
+
# The resource will be in the following format:
|
110
|
+
#
|
111
|
+
# `projects/{project}`
|
112
|
+
#
|
113
|
+
# @param project [String]
|
114
|
+
#
|
115
|
+
# @return [::String]
|
116
|
+
def project_path project:
|
117
|
+
"projects/#{project}"
|
118
|
+
end
|
119
|
+
|
106
120
|
extend self
|
107
121
|
end
|
108
122
|
end
|
@@ -33,6 +33,32 @@ module Google
|
|
33
33
|
module Admin
|
34
34
|
module V1
|
35
35
|
##
|
36
|
+
# The Cloud Firestore Admin API.
|
37
|
+
#
|
38
|
+
# This API provides several administrative services for Cloud Firestore.
|
39
|
+
#
|
40
|
+
# Project, Database, Namespace, Collection, Collection Group, and Document are
|
41
|
+
# used as defined in the Google Cloud Firestore API.
|
42
|
+
#
|
43
|
+
# Operation: An Operation represents work being performed in the background.
|
44
|
+
#
|
45
|
+
# The index service manages Cloud Firestore indexes.
|
46
|
+
#
|
47
|
+
# Index creation is performed asynchronously.
|
48
|
+
# An Operation resource is created for each such asynchronous operation.
|
49
|
+
# The state of the operation (including any errors encountered)
|
50
|
+
# may be queried via the Operation resource.
|
51
|
+
#
|
52
|
+
# The Operations collection provides a record of actions performed for the
|
53
|
+
# specified Project (including any Operations in progress). Operations are not
|
54
|
+
# created directly but through calls on other collections or resources.
|
55
|
+
#
|
56
|
+
# An Operation that is done may be deleted so that it is no longer listed as
|
57
|
+
# part of the Operation collection. Operations are garbage collected after
|
58
|
+
# 30 days. By default, ListOperations will only return in progress and failed
|
59
|
+
# operations. To list completed operation, issue a ListOperations request with
|
60
|
+
# the filter `done: true`.
|
61
|
+
#
|
36
62
|
# Operations are created by service `FirestoreAdmin`, but are accessed via
|
37
63
|
# service `google.longrunning.Operations`.
|
38
64
|
#
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/firestore/admin/v1/database.proto
|
3
|
+
|
4
|
+
require 'google/api/field_behavior_pb'
|
5
|
+
require 'google/api/resource_pb'
|
6
|
+
require 'google/protobuf/duration_pb'
|
7
|
+
require 'google/protobuf/timestamp_pb'
|
8
|
+
require 'google/api/annotations_pb'
|
9
|
+
require 'google/protobuf'
|
10
|
+
|
11
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
|
+
add_file("google/firestore/admin/v1/database.proto", :syntax => :proto3) do
|
13
|
+
add_message "google.firestore.admin.v1.Database" do
|
14
|
+
optional :name, :string, 1
|
15
|
+
optional :location_id, :string, 9
|
16
|
+
optional :type, :enum, 10, "google.firestore.admin.v1.Database.DatabaseType"
|
17
|
+
optional :concurrency_mode, :enum, 15, "google.firestore.admin.v1.Database.ConcurrencyMode"
|
18
|
+
optional :etag, :string, 99
|
19
|
+
end
|
20
|
+
add_enum "google.firestore.admin.v1.Database.DatabaseType" do
|
21
|
+
value :DATABASE_TYPE_UNSPECIFIED, 0
|
22
|
+
value :FIRESTORE_NATIVE, 1
|
23
|
+
value :DATASTORE_MODE, 2
|
24
|
+
end
|
25
|
+
add_enum "google.firestore.admin.v1.Database.ConcurrencyMode" do
|
26
|
+
value :CONCURRENCY_MODE_UNSPECIFIED, 0
|
27
|
+
value :OPTIMISTIC, 1
|
28
|
+
value :PESSIMISTIC, 2
|
29
|
+
value :OPTIMISTIC_WITH_ENTITY_GROUPS, 3
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
module Google
|
35
|
+
module Cloud
|
36
|
+
module Firestore
|
37
|
+
module Admin
|
38
|
+
module V1
|
39
|
+
Database = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database").msgclass
|
40
|
+
Database::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.DatabaseType").enummodule
|
41
|
+
Database::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.ConcurrencyMode").enummodule
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -1,6 +1,7 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/firestore/admin/v1/field.proto
|
3
3
|
|
4
|
+
require 'google/api/field_behavior_pb'
|
4
5
|
require 'google/api/resource_pb'
|
5
6
|
require 'google/firestore/admin/v1/index_pb'
|
6
7
|
require 'google/api/annotations_pb'
|
@@ -5,15 +5,33 @@ require 'google/api/annotations_pb'
|
|
5
5
|
require 'google/api/client_pb'
|
6
6
|
require 'google/api/field_behavior_pb'
|
7
7
|
require 'google/api/resource_pb'
|
8
|
+
require 'google/firestore/admin/v1/database_pb'
|
8
9
|
require 'google/firestore/admin/v1/field_pb'
|
9
10
|
require 'google/firestore/admin/v1/index_pb'
|
11
|
+
require 'google/firestore/admin/v1/operation_pb'
|
10
12
|
require 'google/longrunning/operations_pb'
|
11
13
|
require 'google/protobuf/empty_pb'
|
12
14
|
require 'google/protobuf/field_mask_pb'
|
15
|
+
require 'google/protobuf/timestamp_pb'
|
13
16
|
require 'google/protobuf'
|
14
17
|
|
15
18
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
16
19
|
add_file("google/firestore/admin/v1/firestore_admin.proto", :syntax => :proto3) do
|
20
|
+
add_message "google.firestore.admin.v1.ListDatabasesRequest" do
|
21
|
+
optional :parent, :string, 1
|
22
|
+
end
|
23
|
+
add_message "google.firestore.admin.v1.ListDatabasesResponse" do
|
24
|
+
repeated :databases, :message, 1, "google.firestore.admin.v1.Database"
|
25
|
+
end
|
26
|
+
add_message "google.firestore.admin.v1.GetDatabaseRequest" do
|
27
|
+
optional :name, :string, 1
|
28
|
+
end
|
29
|
+
add_message "google.firestore.admin.v1.UpdateDatabaseRequest" do
|
30
|
+
optional :database, :message, 1, "google.firestore.admin.v1.Database"
|
31
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
32
|
+
end
|
33
|
+
add_message "google.firestore.admin.v1.UpdateDatabaseMetadata" do
|
34
|
+
end
|
17
35
|
add_message "google.firestore.admin.v1.CreateIndexRequest" do
|
18
36
|
optional :parent, :string, 1
|
19
37
|
optional :index, :message, 2, "google.firestore.admin.v1.Index"
|
@@ -69,6 +87,11 @@ module Google
|
|
69
87
|
module Firestore
|
70
88
|
module Admin
|
71
89
|
module V1
|
90
|
+
ListDatabasesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListDatabasesRequest").msgclass
|
91
|
+
ListDatabasesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListDatabasesResponse").msgclass
|
92
|
+
GetDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.GetDatabaseRequest").msgclass
|
93
|
+
UpdateDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateDatabaseRequest").msgclass
|
94
|
+
UpdateDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateDatabaseMetadata").msgclass
|
72
95
|
CreateIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.CreateIndexRequest").msgclass
|
73
96
|
ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesRequest").msgclass
|
74
97
|
ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesResponse").msgclass
|
@@ -1,7 +1,7 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# Source: google/firestore/admin/v1/firestore_admin.proto for package 'Google.Cloud.Firestore.Admin.V1'
|
3
3
|
# Original file comments:
|
4
|
-
# Copyright
|
4
|
+
# Copyright 2021 Google LLC
|
5
5
|
#
|
6
6
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
7
|
# you may not use this file except in compliance with the License.
|
@@ -15,7 +15,6 @@
|
|
15
15
|
# See the License for the specific language governing permissions and
|
16
16
|
# limitations under the License.
|
17
17
|
#
|
18
|
-
#
|
19
18
|
|
20
19
|
require 'grpc'
|
21
20
|
require 'google/firestore/admin/v1/firestore_admin_pb'
|
@@ -26,6 +25,32 @@ module Google
|
|
26
25
|
module Admin
|
27
26
|
module V1
|
28
27
|
module FirestoreAdmin
|
28
|
+
# The Cloud Firestore Admin API.
|
29
|
+
#
|
30
|
+
# This API provides several administrative services for Cloud Firestore.
|
31
|
+
#
|
32
|
+
# Project, Database, Namespace, Collection, Collection Group, and Document are
|
33
|
+
# used as defined in the Google Cloud Firestore API.
|
34
|
+
#
|
35
|
+
# Operation: An Operation represents work being performed in the background.
|
36
|
+
#
|
37
|
+
# The index service manages Cloud Firestore indexes.
|
38
|
+
#
|
39
|
+
# Index creation is performed asynchronously.
|
40
|
+
# An Operation resource is created for each such asynchronous operation.
|
41
|
+
# The state of the operation (including any errors encountered)
|
42
|
+
# may be queried via the Operation resource.
|
43
|
+
#
|
44
|
+
# The Operations collection provides a record of actions performed for the
|
45
|
+
# specified Project (including any Operations in progress). Operations are not
|
46
|
+
# created directly but through calls on other collections or resources.
|
47
|
+
#
|
48
|
+
# An Operation that is done may be deleted so that it is no longer listed as
|
49
|
+
# part of the Operation collection. Operations are garbage collected after
|
50
|
+
# 30 days. By default, ListOperations will only return in progress and failed
|
51
|
+
# operations. To list completed operation, issue a ListOperations request with
|
52
|
+
# the filter `done: true`.
|
53
|
+
#
|
29
54
|
# Operations are created by service `FirestoreAdmin`, but are accessed via
|
30
55
|
# service `google.longrunning.Operations`.
|
31
56
|
class Service
|
@@ -67,7 +92,7 @@ module Google
|
|
67
92
|
# Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
|
68
93
|
# that have been explicitly overridden. To issue this query, call
|
69
94
|
# [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
|
70
|
-
# `indexConfig.usesAncestorConfig:false
|
95
|
+
# `indexConfig.usesAncestorConfig:false` .
|
71
96
|
rpc :ListFields, ::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest, ::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse
|
72
97
|
# Exports a copy of all or a subset of documents from Google Cloud Firestore
|
73
98
|
# to another storage system, such as Google Cloud Storage. Recent updates to
|
@@ -77,6 +102,9 @@ module Google
|
|
77
102
|
# used once the associated operation is done. If an export operation is
|
78
103
|
# cancelled before completion it may leave partial data behind in Google
|
79
104
|
# Cloud Storage.
|
105
|
+
#
|
106
|
+
# For more details on export behavior and output format, refer to:
|
107
|
+
# https://cloud.google.com/firestore/docs/manage-data/export-import
|
80
108
|
rpc :ExportDocuments, ::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest, ::Google::Longrunning::Operation
|
81
109
|
# Imports documents into Google Cloud Firestore. Existing documents with the
|
82
110
|
# same name are overwritten. The import occurs in the background and its
|
@@ -84,6 +112,12 @@ module Google
|
|
84
112
|
# created. If an ImportDocuments operation is cancelled, it is possible
|
85
113
|
# that a subset of the data has already been imported to Cloud Firestore.
|
86
114
|
rpc :ImportDocuments, ::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest, ::Google::Longrunning::Operation
|
115
|
+
# Gets information about a database.
|
116
|
+
rpc :GetDatabase, ::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest, ::Google::Cloud::Firestore::Admin::V1::Database
|
117
|
+
# List all the databases in the project.
|
118
|
+
rpc :ListDatabases, ::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest, ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse
|
119
|
+
# Updates a database.
|
120
|
+
rpc :UpdateDatabase, ::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest, ::Google::Longrunning::Operation
|
87
121
|
end
|
88
122
|
|
89
123
|
Stub = Service.rpc_stub_class
|
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -0,0 +1,91 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Firestore
|
23
|
+
module Admin
|
24
|
+
module V1
|
25
|
+
# A Cloud Firestore Database.
|
26
|
+
# Currently only one database is allowed per cloud project; this database
|
27
|
+
# must have a `database_id` of '(default)'.
|
28
|
+
# @!attribute [rw] name
|
29
|
+
# @return [::String]
|
30
|
+
# The resource name of the Database.
|
31
|
+
# Format: `projects/{project}/databases/{database}`
|
32
|
+
# @!attribute [rw] location_id
|
33
|
+
# @return [::String]
|
34
|
+
# The location of the database. Available databases are listed at
|
35
|
+
# https://cloud.google.com/firestore/docs/locations.
|
36
|
+
# @!attribute [rw] type
|
37
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database::DatabaseType]
|
38
|
+
# The type of the database.
|
39
|
+
# See https://cloud.google.com/datastore/docs/firestore-or-datastore for
|
40
|
+
# information about how to choose.
|
41
|
+
# @!attribute [rw] concurrency_mode
|
42
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode]
|
43
|
+
# The concurrency control mode to use for this database.
|
44
|
+
# @!attribute [rw] etag
|
45
|
+
# @return [::String]
|
46
|
+
# This checksum is computed by the server based on the value of other
|
47
|
+
# fields, and may be sent on update and delete requests to ensure the
|
48
|
+
# client has an up-to-date value before proceeding.
|
49
|
+
class Database
|
50
|
+
include ::Google::Protobuf::MessageExts
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
|
53
|
+
# The type of the database.
|
54
|
+
# See https://cloud.google.com/datastore/docs/firestore-or-datastore for
|
55
|
+
# information about how to choose.
|
56
|
+
module DatabaseType
|
57
|
+
# The default value. This value is used if the database type is omitted.
|
58
|
+
DATABASE_TYPE_UNSPECIFIED = 0
|
59
|
+
|
60
|
+
# Firestore Native Mode
|
61
|
+
FIRESTORE_NATIVE = 1
|
62
|
+
|
63
|
+
# Firestore in Datastore Mode.
|
64
|
+
DATASTORE_MODE = 2
|
65
|
+
end
|
66
|
+
|
67
|
+
# The type of concurrency control mode for transactions.
|
68
|
+
module ConcurrencyMode
|
69
|
+
# Not used.
|
70
|
+
CONCURRENCY_MODE_UNSPECIFIED = 0
|
71
|
+
|
72
|
+
# Use optimistic concurrency control by default. This setting is available
|
73
|
+
# for Cloud Firestore customers.
|
74
|
+
OPTIMISTIC = 1
|
75
|
+
|
76
|
+
# Use pessimistic concurrency control by default. This setting is available
|
77
|
+
# for Cloud Firestore customers.
|
78
|
+
# This is the default setting for Cloud Firestore.
|
79
|
+
PESSIMISTIC = 2
|
80
|
+
|
81
|
+
# Use optimistic concurrency control with entity groups by default. This is
|
82
|
+
# the only available setting for Cloud Datastore customers.
|
83
|
+
# This is the default setting for Cloud Datastore.
|
84
|
+
OPTIMISTIC_WITH_ENTITY_GROUPS = 3
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
@@ -28,7 +28,7 @@ module Google
|
|
28
28
|
# collections in the database with the same id.
|
29
29
|
# @!attribute [rw] name
|
30
30
|
# @return [::String]
|
31
|
-
# A field name of the form
|
31
|
+
# Required. A field name of the form
|
32
32
|
# `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
|
33
33
|
#
|
34
34
|
# A field path may be a simple field name, e.g. `address` or a path to fields
|
@@ -22,6 +22,53 @@ module Google
|
|
22
22
|
module Firestore
|
23
23
|
module Admin
|
24
24
|
module V1
|
25
|
+
# A request to list the Firestore Databases in all locations for a project.
|
26
|
+
# @!attribute [rw] parent
|
27
|
+
# @return [::String]
|
28
|
+
# Required. A parent name of the form
|
29
|
+
# `projects/{project_id}`
|
30
|
+
class ListDatabasesRequest
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# The list of databases for a project.
|
36
|
+
# @!attribute [rw] databases
|
37
|
+
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Database>]
|
38
|
+
# The databases in the project.
|
39
|
+
class ListDatabasesResponse
|
40
|
+
include ::Google::Protobuf::MessageExts
|
41
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
42
|
+
end
|
43
|
+
|
44
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_database FirestoreAdmin.GetDatabase}.
|
45
|
+
# @!attribute [rw] name
|
46
|
+
# @return [::String]
|
47
|
+
# Required. A name of the form
|
48
|
+
# `projects/{project_id}/databases/{database_id}`
|
49
|
+
class GetDatabaseRequest
|
50
|
+
include ::Google::Protobuf::MessageExts
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
end
|
53
|
+
|
54
|
+
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_database FirestoreAdmin.UpdateDatabase}.
|
55
|
+
# @!attribute [rw] database
|
56
|
+
# @return [::Google::Cloud::Firestore::Admin::V1::Database]
|
57
|
+
# Required. The database to update.
|
58
|
+
# @!attribute [rw] update_mask
|
59
|
+
# @return [::Google::Protobuf::FieldMask]
|
60
|
+
# The list of fields to be updated.
|
61
|
+
class UpdateDatabaseRequest
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
|
66
|
+
# Metadata related to the update database operation.
|
67
|
+
class UpdateDatabaseMetadata
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
25
72
|
# The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
|
26
73
|
# @!attribute [rw] parent
|
27
74
|
# @return [::String]
|
@@ -122,8 +169,8 @@ module Google
|
|
122
169
|
# The filter to apply to list results. Currently,
|
123
170
|
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
|
124
171
|
# that have been explicitly overridden. To issue this query, call
|
125
|
-
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with
|
126
|
-
# `indexConfig.usesAncestorConfig:false
|
172
|
+
# {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with a filter that includes
|
173
|
+
# `indexConfig.usesAncestorConfig:false` .
|
127
174
|
# @!attribute [rw] page_size
|
128
175
|
# @return [::Integer]
|
129
176
|
# The number of results to return.
|
@@ -70,7 +70,7 @@ module Google
|
|
70
70
|
# @!attribute [rw] order
|
71
71
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
|
72
72
|
# Indicates that this field supports ordering by the specified order or
|
73
|
-
# comparing using =, <, <=, >, >=.
|
73
|
+
# comparing using =, !=, <, <=, >, >=.
|
74
74
|
# @!attribute [rw] array_config
|
75
75
|
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
|
76
76
|
# Indicates that this field supports operations on `array_value`s.
|
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.4.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:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -177,6 +177,7 @@ files:
|
|
177
177
|
- lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb
|
178
178
|
- lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb
|
179
179
|
- lib/google/cloud/firestore/admin/v1/version.rb
|
180
|
+
- lib/google/firestore/admin/v1/database_pb.rb
|
180
181
|
- lib/google/firestore/admin/v1/field_pb.rb
|
181
182
|
- lib/google/firestore/admin/v1/firestore_admin_pb.rb
|
182
183
|
- lib/google/firestore/admin/v1/firestore_admin_services_pb.rb
|
@@ -186,6 +187,7 @@ files:
|
|
186
187
|
- proto_docs/README.md
|
187
188
|
- proto_docs/google/api/field_behavior.rb
|
188
189
|
- proto_docs/google/api/resource.rb
|
190
|
+
- proto_docs/google/firestore/admin/v1/database.rb
|
189
191
|
- proto_docs/google/firestore/admin/v1/field.rb
|
190
192
|
- proto_docs/google/firestore/admin/v1/firestore_admin.rb
|
191
193
|
- proto_docs/google/firestore/admin/v1/index.rb
|
@@ -218,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
218
220
|
- !ruby/object:Gem::Version
|
219
221
|
version: '0'
|
220
222
|
requirements: []
|
221
|
-
rubygems_version: 3.
|
223
|
+
rubygems_version: 3.3.4
|
222
224
|
signing_key:
|
223
225
|
specification_version: 4
|
224
226
|
summary: API Client library for the Cloud Firestore Admin V1 API
|