google-apis-firestore_v1 0.10.0 → 0.11.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: 87cf709cb6b999192fd73b322431b1c20b5932978ce5c955680151d96de380e8
|
4
|
+
data.tar.gz: f3301b349979e4bfdc7d913fec13509becf2e9abca185767786927bf9e9f01a6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5a714e9f4e9913c9b1c9cd56f67239f250fe4c963a3f780ff0d6c7d276cb77d563e87527d7387928aff9fd50e164f042024bb16d896dd4f096747c23dcaeaf14
|
7
|
+
data.tar.gz: a9c4c525aca826608cdd8728cc22cbb1a533fe76ce4c2ca19b588146ecc0d5cf6a9e2ee6018a4d56d68256fbf8333b92d394e1a714e262b4b07a5f91fefca599
|
data/CHANGELOG.md
CHANGED
@@ -775,6 +775,55 @@ module Google
|
|
775
775
|
end
|
776
776
|
end
|
777
777
|
|
778
|
+
# A Cloud Firestore Database in Native Mode. Currently one database is allowed
|
779
|
+
# per cloud project. It is named '(default)'
|
780
|
+
class GoogleFirestoreAdminV1Database
|
781
|
+
include Google::Apis::Core::Hashable
|
782
|
+
|
783
|
+
# The concurrency control mode to use for this database.
|
784
|
+
# Corresponds to the JSON property `concurrencyMode`
|
785
|
+
# @return [String]
|
786
|
+
attr_accessor :concurrency_mode
|
787
|
+
|
788
|
+
# This checksum is computed by the server based on the value of other fields,
|
789
|
+
# and may be sent on update and delete requests to ensure the client has an up-
|
790
|
+
# to-date value before proceeding.
|
791
|
+
# Corresponds to the JSON property `etag`
|
792
|
+
# @return [String]
|
793
|
+
attr_accessor :etag
|
794
|
+
|
795
|
+
# The location of the database. Available databases are listed at https://cloud.
|
796
|
+
# google.com/firestore/docs/locations.
|
797
|
+
# Corresponds to the JSON property `locationId`
|
798
|
+
# @return [String]
|
799
|
+
attr_accessor :location_id
|
800
|
+
|
801
|
+
# The resource name of the Database. Format: `projects/`project`/databases/`
|
802
|
+
# database``
|
803
|
+
# Corresponds to the JSON property `name`
|
804
|
+
# @return [String]
|
805
|
+
attr_accessor :name
|
806
|
+
|
807
|
+
# The type of the database. See https://cloud.google.com/datastore/docs/
|
808
|
+
# firestore-or-datastore for information about how to choose.
|
809
|
+
# Corresponds to the JSON property `type`
|
810
|
+
# @return [String]
|
811
|
+
attr_accessor :type
|
812
|
+
|
813
|
+
def initialize(**args)
|
814
|
+
update!(**args)
|
815
|
+
end
|
816
|
+
|
817
|
+
# Update properties of this object
|
818
|
+
def update!(**args)
|
819
|
+
@concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
|
820
|
+
@etag = args[:etag] if args.key?(:etag)
|
821
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
822
|
+
@name = args[:name] if args.key?(:name)
|
823
|
+
@type = args[:type] if args.key?(:type)
|
824
|
+
end
|
825
|
+
end
|
826
|
+
|
778
827
|
# Metadata for google.longrunning.Operation results from FirestoreAdmin.
|
779
828
|
# ExportDocuments.
|
780
829
|
class GoogleFirestoreAdminV1ExportDocumentsMetadata
|
@@ -1292,6 +1341,25 @@ module Google
|
|
1292
1341
|
end
|
1293
1342
|
end
|
1294
1343
|
|
1344
|
+
# The list of databases for a project.
|
1345
|
+
class GoogleFirestoreAdminV1ListDatabasesResponse
|
1346
|
+
include Google::Apis::Core::Hashable
|
1347
|
+
|
1348
|
+
# The databases in the project.
|
1349
|
+
# Corresponds to the JSON property `databases`
|
1350
|
+
# @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database>]
|
1351
|
+
attr_accessor :databases
|
1352
|
+
|
1353
|
+
def initialize(**args)
|
1354
|
+
update!(**args)
|
1355
|
+
end
|
1356
|
+
|
1357
|
+
# Update properties of this object
|
1358
|
+
def update!(**args)
|
1359
|
+
@databases = args[:databases] if args.key?(:databases)
|
1360
|
+
end
|
1361
|
+
end
|
1362
|
+
|
1295
1363
|
# The response for FirestoreAdmin.ListFields.
|
1296
1364
|
class GoogleFirestoreAdminV1ListFieldsResponse
|
1297
1365
|
include Google::Apis::Core::Hashable
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module FirestoreV1
|
18
18
|
# Version of the google-apis-firestore_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.11.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210916"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -172,6 +172,12 @@ module Google
|
|
172
172
|
include Google::Apis::Core::JsonObjectSupport
|
173
173
|
end
|
174
174
|
|
175
|
+
class GoogleFirestoreAdminV1Database
|
176
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
177
|
+
|
178
|
+
include Google::Apis::Core::JsonObjectSupport
|
179
|
+
end
|
180
|
+
|
175
181
|
class GoogleFirestoreAdminV1ExportDocumentsMetadata
|
176
182
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
177
183
|
|
@@ -244,6 +250,12 @@ module Google
|
|
244
250
|
include Google::Apis::Core::JsonObjectSupport
|
245
251
|
end
|
246
252
|
|
253
|
+
class GoogleFirestoreAdminV1ListDatabasesResponse
|
254
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
255
|
+
|
256
|
+
include Google::Apis::Core::JsonObjectSupport
|
257
|
+
end
|
258
|
+
|
247
259
|
class GoogleFirestoreAdminV1ListFieldsResponse
|
248
260
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
249
261
|
|
@@ -706,6 +718,17 @@ module Google
|
|
706
718
|
end
|
707
719
|
end
|
708
720
|
|
721
|
+
class GoogleFirestoreAdminV1Database
|
722
|
+
# @private
|
723
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
724
|
+
property :concurrency_mode, as: 'concurrencyMode'
|
725
|
+
property :etag, as: 'etag'
|
726
|
+
property :location_id, as: 'locationId'
|
727
|
+
property :name, as: 'name'
|
728
|
+
property :type, as: 'type'
|
729
|
+
end
|
730
|
+
end
|
731
|
+
|
709
732
|
class GoogleFirestoreAdminV1ExportDocumentsMetadata
|
710
733
|
# @private
|
711
734
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -838,6 +861,14 @@ module Google
|
|
838
861
|
end
|
839
862
|
end
|
840
863
|
|
864
|
+
class GoogleFirestoreAdminV1ListDatabasesResponse
|
865
|
+
# @private
|
866
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
867
|
+
collection :databases, as: 'databases', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
|
868
|
+
|
869
|
+
end
|
870
|
+
end
|
871
|
+
|
841
872
|
class GoogleFirestoreAdminV1ListFieldsResponse
|
842
873
|
# @private
|
843
874
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -92,6 +92,36 @@ module Google
|
|
92
92
|
execute_or_queue_command(command, &block)
|
93
93
|
end
|
94
94
|
|
95
|
+
# Gets information about a database.
|
96
|
+
# @param [String] name
|
97
|
+
# Required. A name of the form `projects/`project_id`/databases/`database_id``
|
98
|
+
# @param [String] fields
|
99
|
+
# Selector specifying which fields to include in a partial response.
|
100
|
+
# @param [String] quota_user
|
101
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
102
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
103
|
+
# @param [Google::Apis::RequestOptions] options
|
104
|
+
# Request-specific options
|
105
|
+
#
|
106
|
+
# @yield [result, err] Result & error if block supplied
|
107
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database] parsed result object
|
108
|
+
# @yieldparam err [StandardError] error object if request failed
|
109
|
+
#
|
110
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database]
|
111
|
+
#
|
112
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
113
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
114
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
115
|
+
def get_project_database(name, fields: nil, quota_user: nil, options: nil, &block)
|
116
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
117
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
|
118
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database
|
119
|
+
command.params['name'] = name unless name.nil?
|
120
|
+
command.query['fields'] = fields unless fields.nil?
|
121
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
122
|
+
execute_or_queue_command(command, &block)
|
123
|
+
end
|
124
|
+
|
95
125
|
# Imports documents into Google Cloud Firestore. Existing documents with the
|
96
126
|
# same name are overwritten. The import occurs in the background and its
|
97
127
|
# progress can be monitored and managed via the Operation resource that is
|
@@ -130,6 +160,73 @@ module Google
|
|
130
160
|
execute_or_queue_command(command, &block)
|
131
161
|
end
|
132
162
|
|
163
|
+
# List all the databases in the project.
|
164
|
+
# @param [String] parent
|
165
|
+
# Required. A parent name of the form `projects/`project_id``
|
166
|
+
# @param [String] fields
|
167
|
+
# Selector specifying which fields to include in a partial response.
|
168
|
+
# @param [String] quota_user
|
169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
171
|
+
# @param [Google::Apis::RequestOptions] options
|
172
|
+
# Request-specific options
|
173
|
+
#
|
174
|
+
# @yield [result, err] Result & error if block supplied
|
175
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse] parsed result object
|
176
|
+
# @yieldparam err [StandardError] error object if request failed
|
177
|
+
#
|
178
|
+
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse]
|
179
|
+
#
|
180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
183
|
+
def list_project_databases(parent, fields: nil, quota_user: nil, options: nil, &block)
|
184
|
+
command = make_simple_command(:get, 'v1/{+parent}/databases', options)
|
185
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse::Representation
|
186
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse
|
187
|
+
command.params['parent'] = parent unless parent.nil?
|
188
|
+
command.query['fields'] = fields unless fields.nil?
|
189
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
190
|
+
execute_or_queue_command(command, &block)
|
191
|
+
end
|
192
|
+
|
193
|
+
# Updates a database.
|
194
|
+
# @param [String] name
|
195
|
+
# The resource name of the Database. Format: `projects/`project`/databases/`
|
196
|
+
# database``
|
197
|
+
# @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database] google_firestore_admin_v1_database_object
|
198
|
+
# @param [String] update_mask
|
199
|
+
# The list of fields to be updated.
|
200
|
+
# @param [String] fields
|
201
|
+
# Selector specifying which fields to include in a partial response.
|
202
|
+
# @param [String] quota_user
|
203
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
204
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
205
|
+
# @param [Google::Apis::RequestOptions] options
|
206
|
+
# Request-specific options
|
207
|
+
#
|
208
|
+
# @yield [result, err] Result & error if block supplied
|
209
|
+
# @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object
|
210
|
+
# @yieldparam err [StandardError] error object if request failed
|
211
|
+
#
|
212
|
+
# @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
|
213
|
+
#
|
214
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
215
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
216
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
217
|
+
def patch_project_database(name, google_firestore_admin_v1_database_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
218
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
219
|
+
command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database::Representation
|
220
|
+
command.request_object = google_firestore_admin_v1_database_object
|
221
|
+
command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
|
222
|
+
command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
|
223
|
+
command.params['name'] = name unless name.nil?
|
224
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
225
|
+
command.query['fields'] = fields unless fields.nil?
|
226
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
227
|
+
execute_or_queue_command(command, &block)
|
228
|
+
end
|
229
|
+
|
133
230
|
# Gets the metadata and configuration for a Field.
|
134
231
|
# @param [String] name
|
135
232
|
# Required. A name of the form `projects/`project_id`/databases/`database_id`/
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-firestore_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.11.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: 2021-
|
11
|
+
date: 2021-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firestore_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.11.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firestore_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|