google-cloud-firestore 1.1.0 → 1.2.4
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/AUTHENTICATION.md +4 -26
- data/CHANGELOG.md +39 -0
- data/CONTRIBUTING.md +1 -1
- data/OVERVIEW.md +5 -3
- data/lib/google/cloud/firestore/admin/v1/credentials.rb +1 -1
- data/lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/field.rb +3 -5
- data/lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb +11 -11
- data/lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb +8 -5
- data/lib/google/cloud/firestore/admin/v1/doc/google/longrunning/operations.rb +2 -2
- data/lib/google/cloud/firestore/admin/v1/doc/google/protobuf/any.rb +1 -1
- data/lib/google/cloud/firestore/admin/v1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/firestore/admin/v1/doc/google/protobuf/field_mask.rb +1 -1
- data/lib/google/cloud/firestore/admin/v1/doc/google/rpc/status.rb +7 -55
- data/lib/google/cloud/firestore/admin/v1/firestore_admin_client.rb +11 -11
- data/lib/google/cloud/firestore/admin/v1/firestore_admin_client_config.json +3 -2
- data/lib/google/cloud/firestore/admin/v1.rb +1 -1
- data/lib/google/cloud/firestore/admin.rb +1 -1
- data/lib/google/cloud/firestore/client.rb +1 -1
- data/lib/google/cloud/firestore/document_reference/list.rb +9 -9
- data/lib/google/cloud/firestore/v1/credentials.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/common.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb +25 -33
- data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/query.rb +15 -7
- data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/write.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/protobuf/any.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/protobuf/timestamp.rb +7 -5
- data/lib/google/cloud/firestore/v1/doc/google/protobuf/wrappers.rb +1 -1
- data/lib/google/cloud/firestore/v1/doc/google/rpc/status.rb +7 -55
- data/lib/google/cloud/firestore/v1/firestore_client.rb +22 -30
- data/lib/google/cloud/firestore/v1/firestore_client_config.json +5 -4
- data/lib/google/cloud/firestore/v1.rb +7 -15
- data/lib/google/cloud/firestore/v1beta1/credentials.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/common.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/document.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb +21 -31
- data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb +19 -11
- data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/any.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/timestamp.rb +7 -5
- data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/wrappers.rb +1 -1
- data/lib/google/cloud/firestore/v1beta1/doc/google/rpc/status.rb +7 -55
- data/lib/google/cloud/firestore/v1beta1/firestore_client.rb +16 -16
- data/lib/google/cloud/firestore/v1beta1.rb +1 -1
- data/lib/google/cloud/firestore/version.rb +1 -1
- data/lib/google/cloud/firestore/watch/listener.rb +2 -2
- data/lib/google/firestore/admin/v1/field_pb.rb +1 -0
- data/lib/google/firestore/admin/v1/firestore_admin_pb.rb +3 -0
- data/lib/google/firestore/admin/v1/index_pb.rb +2 -0
- data/lib/google/firestore/v1/firestore_pb.rb +2 -0
- data/lib/google/firestore/v1/firestore_services_pb.rb +8 -14
- data/lib/google/firestore/v1/query_pb.rb +6 -4
- data/lib/google/firestore/v1beta1/firestore_pb.rb +2 -0
- data/lib/google/firestore/v1beta1/firestore_services_pb.rb +2 -0
- data/lib/google/firestore/v1beta1/query_pb.rb +6 -4
- metadata +60 -20
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright
|
1
|
+
# Copyright 2020 Google LLC
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -19,7 +19,7 @@ module Google
|
|
19
19
|
# The request for {Google::Firestore::V1::Firestore::GetDocument Firestore::GetDocument}.
|
20
20
|
# @!attribute [rw] name
|
21
21
|
# @return [String]
|
22
|
-
# The resource name of the Document to get. In the format:
|
22
|
+
# Required. The resource name of the Document to get. In the format:
|
23
23
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
24
24
|
# @!attribute [rw] mask
|
25
25
|
# @return [Google::Firestore::V1::DocumentMask]
|
@@ -39,7 +39,7 @@ module Google
|
|
39
39
|
# The request for {Google::Firestore::V1::Firestore::ListDocuments Firestore::ListDocuments}.
|
40
40
|
# @!attribute [rw] parent
|
41
41
|
# @return [String]
|
42
|
-
# The parent resource name. In the format:
|
42
|
+
# Required. The parent resource name. In the format:
|
43
43
|
# `projects/{project_id}/databases/{database_id}/documents` or
|
44
44
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
45
45
|
# For example:
|
@@ -47,7 +47,7 @@ module Google
|
|
47
47
|
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
48
48
|
# @!attribute [rw] collection_id
|
49
49
|
# @return [String]
|
50
|
-
# The collection ID, relative to `parent`, to list. For example: `chatrooms`
|
50
|
+
# Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
|
51
51
|
# or `messages`.
|
52
52
|
# @!attribute [rw] page_size
|
53
53
|
# @return [Integer]
|
@@ -94,12 +94,12 @@ module Google
|
|
94
94
|
# The request for {Google::Firestore::V1::Firestore::CreateDocument Firestore::CreateDocument}.
|
95
95
|
# @!attribute [rw] parent
|
96
96
|
# @return [String]
|
97
|
-
# The parent resource. For example:
|
97
|
+
# Required. The parent resource. For example:
|
98
98
|
# `projects/{project_id}/databases/{database_id}/documents` or
|
99
99
|
# `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
|
100
100
|
# @!attribute [rw] collection_id
|
101
101
|
# @return [String]
|
102
|
-
# The collection ID, relative to `parent`, to list. For example: `chatrooms`.
|
102
|
+
# Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
|
103
103
|
# @!attribute [rw] document_id
|
104
104
|
# @return [String]
|
105
105
|
# The client-assigned document ID to use for this document.
|
@@ -107,7 +107,7 @@ module Google
|
|
107
107
|
# Optional. If not specified, an ID will be assigned by the service.
|
108
108
|
# @!attribute [rw] document
|
109
109
|
# @return [Google::Firestore::V1::Document]
|
110
|
-
# The document to create. `name` must not be set.
|
110
|
+
# Required. The document to create. `name` must not be set.
|
111
111
|
# @!attribute [rw] mask
|
112
112
|
# @return [Google::Firestore::V1::DocumentMask]
|
113
113
|
# The fields to return. If not set, returns all fields.
|
@@ -119,7 +119,7 @@ module Google
|
|
119
119
|
# The request for {Google::Firestore::V1::Firestore::UpdateDocument Firestore::UpdateDocument}.
|
120
120
|
# @!attribute [rw] document
|
121
121
|
# @return [Google::Firestore::V1::Document]
|
122
|
-
# The updated document.
|
122
|
+
# Required. The updated document.
|
123
123
|
# Creates the document if it does not already exist.
|
124
124
|
# @!attribute [rw] update_mask
|
125
125
|
# @return [Google::Firestore::V1::DocumentMask]
|
@@ -145,7 +145,7 @@ module Google
|
|
145
145
|
# The request for {Google::Firestore::V1::Firestore::DeleteDocument Firestore::DeleteDocument}.
|
146
146
|
# @!attribute [rw] name
|
147
147
|
# @return [String]
|
148
|
-
# The resource name of the Document to delete. In the format:
|
148
|
+
# Required. The resource name of the Document to delete. In the format:
|
149
149
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
150
150
|
# @!attribute [rw] current_document
|
151
151
|
# @return [Google::Firestore::V1::Precondition]
|
@@ -156,7 +156,7 @@ module Google
|
|
156
156
|
# The request for {Google::Firestore::V1::Firestore::BatchGetDocuments Firestore::BatchGetDocuments}.
|
157
157
|
# @!attribute [rw] database
|
158
158
|
# @return [String]
|
159
|
-
# The database name. In the format:
|
159
|
+
# Required. The database name. In the format:
|
160
160
|
# `projects/{project_id}/databases/{database_id}`.
|
161
161
|
# @!attribute [rw] documents
|
162
162
|
# @return [Array<String>]
|
@@ -209,7 +209,7 @@ module Google
|
|
209
209
|
# The request for {Google::Firestore::V1::Firestore::BeginTransaction Firestore::BeginTransaction}.
|
210
210
|
# @!attribute [rw] database
|
211
211
|
# @return [String]
|
212
|
-
# The database name. In the format:
|
212
|
+
# Required. The database name. In the format:
|
213
213
|
# `projects/{project_id}/databases/{database_id}`.
|
214
214
|
# @!attribute [rw] options
|
215
215
|
# @return [Google::Firestore::V1::TransactionOptions]
|
@@ -226,7 +226,7 @@ module Google
|
|
226
226
|
# The request for {Google::Firestore::V1::Firestore::Commit Firestore::Commit}.
|
227
227
|
# @!attribute [rw] database
|
228
228
|
# @return [String]
|
229
|
-
# The database name. In the format:
|
229
|
+
# Required. The database name. In the format:
|
230
230
|
# `projects/{project_id}/databases/{database_id}`.
|
231
231
|
# @!attribute [rw] writes
|
232
232
|
# @return [Array<Google::Firestore::V1::Write>]
|
@@ -247,23 +247,24 @@ module Google
|
|
247
247
|
# request.
|
248
248
|
# @!attribute [rw] commit_time
|
249
249
|
# @return [Google::Protobuf::Timestamp]
|
250
|
-
# The time at which the commit occurred.
|
250
|
+
# The time at which the commit occurred. Any read with an equal or greater
|
251
|
+
# `read_time` is guaranteed to see the effects of the commit.
|
251
252
|
class CommitResponse; end
|
252
253
|
|
253
254
|
# The request for {Google::Firestore::V1::Firestore::Rollback Firestore::Rollback}.
|
254
255
|
# @!attribute [rw] database
|
255
256
|
# @return [String]
|
256
|
-
# The database name. In the format:
|
257
|
+
# Required. The database name. In the format:
|
257
258
|
# `projects/{project_id}/databases/{database_id}`.
|
258
259
|
# @!attribute [rw] transaction
|
259
260
|
# @return [String]
|
260
|
-
# The transaction to roll back.
|
261
|
+
# Required. The transaction to roll back.
|
261
262
|
class RollbackRequest; end
|
262
263
|
|
263
264
|
# The request for {Google::Firestore::V1::Firestore::RunQuery Firestore::RunQuery}.
|
264
265
|
# @!attribute [rw] parent
|
265
266
|
# @return [String]
|
266
|
-
# The parent resource name. In the format:
|
267
|
+
# Required. The parent resource name. In the format:
|
267
268
|
# `projects/{project_id}/databases/{database_id}/documents` or
|
268
269
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
269
270
|
# For example:
|
@@ -325,7 +326,7 @@ module Google
|
|
325
326
|
# the next request.
|
326
327
|
# @!attribute [rw] database
|
327
328
|
# @return [String]
|
328
|
-
# The database name. In the format:
|
329
|
+
# Required. The database name. In the format:
|
329
330
|
# `projects/{project_id}/databases/{database_id}`.
|
330
331
|
# This is only required in the first message.
|
331
332
|
# @!attribute [rw] stream_id
|
@@ -381,13 +382,14 @@ module Google
|
|
381
382
|
# request.
|
382
383
|
# @!attribute [rw] commit_time
|
383
384
|
# @return [Google::Protobuf::Timestamp]
|
384
|
-
# The time at which the commit occurred.
|
385
|
+
# The time at which the commit occurred. Any read with an equal or greater
|
386
|
+
# `read_time` is guaranteed to see the effects of the write.
|
385
387
|
class WriteResponse; end
|
386
388
|
|
387
389
|
# A request for {Google::Firestore::V1::Firestore::Listen Firestore::Listen}
|
388
390
|
# @!attribute [rw] database
|
389
391
|
# @return [String]
|
390
|
-
# The database name. In the format:
|
392
|
+
# Required. The database name. In the format:
|
391
393
|
# `projects/{project_id}/databases/{database_id}`.
|
392
394
|
# @!attribute [rw] add_target
|
393
395
|
# @return [Google::Firestore::V1::Target]
|
@@ -442,14 +444,8 @@ module Google
|
|
442
444
|
# The client must know the state of matching documents at this time.
|
443
445
|
# @!attribute [rw] target_id
|
444
446
|
# @return [Integer]
|
445
|
-
#
|
446
|
-
#
|
447
|
-
# If not set, the server will assign an ID for the target.
|
448
|
-
#
|
449
|
-
# Used for resuming a target without changing IDs. The IDs can either be
|
450
|
-
# client-assigned or be server-assigned in a previous stream. All targets
|
451
|
-
# with client provided IDs must be added before adding a target that needs
|
452
|
-
# a server-assigned id.
|
447
|
+
# The target ID that identifies the target on the stream. Must be a positive
|
448
|
+
# number and non-zero.
|
453
449
|
# @!attribute [rw] once
|
454
450
|
# @return [true, false]
|
455
451
|
# If the target should be removed once it is current and consistent.
|
@@ -488,11 +484,7 @@ module Google
|
|
488
484
|
#
|
489
485
|
# If empty, the change applies to all targets.
|
490
486
|
#
|
491
|
-
#
|
492
|
-
# of the requests to add the targets. This allows clients to unambiguously
|
493
|
-
# associate server-assigned target IDs with added targets.
|
494
|
-
#
|
495
|
-
# For other states, the order of the target IDs is not defined.
|
487
|
+
# The order of the target IDs is not defined.
|
496
488
|
# @!attribute [rw] cause
|
497
489
|
# @return [Google::Rpc::Status]
|
498
490
|
# The error that resulted in this change, if applicable.
|
@@ -548,7 +540,7 @@ module Google
|
|
548
540
|
# The request for {Google::Firestore::V1::Firestore::ListCollectionIds Firestore::ListCollectionIds}.
|
549
541
|
# @!attribute [rw] parent
|
550
542
|
# @return [String]
|
551
|
-
# The parent document. In the format:
|
543
|
+
# Required. The parent document. In the format:
|
552
544
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
553
545
|
# For example:
|
554
546
|
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright
|
1
|
+
# Copyright 2020 Google LLC
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -142,6 +142,14 @@ module Google
|
|
142
142
|
|
143
143
|
# Contains. Requires that the field is an array.
|
144
144
|
ARRAY_CONTAINS = 7
|
145
|
+
|
146
|
+
# In. Requires that `value` is a non-empty ArrayValue with at most 10
|
147
|
+
# values.
|
148
|
+
IN = 8
|
149
|
+
|
150
|
+
# Contains any. Requires that the field is an array and
|
151
|
+
# `value` is a non-empty ArrayValue with at most 10 values.
|
152
|
+
ARRAY_CONTAINS_ANY = 9
|
145
153
|
end
|
146
154
|
end
|
147
155
|
|
@@ -161,16 +169,11 @@ module Google
|
|
161
169
|
# Test if a field is equal to NaN.
|
162
170
|
IS_NAN = 2
|
163
171
|
|
164
|
-
# Test if an
|
172
|
+
# Test if an expression evaluates to Null.
|
165
173
|
IS_NULL = 3
|
166
174
|
end
|
167
175
|
end
|
168
176
|
|
169
|
-
# A reference to a field, such as `max(messages.time) as max_time`.
|
170
|
-
# @!attribute [rw] field_path
|
171
|
-
# @return [String]
|
172
|
-
class FieldReference; end
|
173
|
-
|
174
177
|
# An order on a field.
|
175
178
|
# @!attribute [rw] field
|
176
179
|
# @return [Google::Firestore::V1::StructuredQuery::FieldReference]
|
@@ -180,6 +183,11 @@ module Google
|
|
180
183
|
# The direction to order by. Defaults to `ASCENDING`.
|
181
184
|
class Order; end
|
182
185
|
|
186
|
+
# A reference to a field, such as `max(messages.time) as max_time`.
|
187
|
+
# @!attribute [rw] field_path
|
188
|
+
# @return [String]
|
189
|
+
class FieldReference; end
|
190
|
+
|
183
191
|
# The projection of document's fields to return.
|
184
192
|
# @!attribute [rw] fields
|
185
193
|
# @return [Array<Google::Firestore::V1::StructuredQuery::FieldReference>]
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright
|
1
|
+
# Copyright 2020 Google LLC
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -88,11 +88,13 @@ module Google
|
|
88
88
|
# 01:30 UTC on January 15, 2017.
|
89
89
|
#
|
90
90
|
# In JavaScript, one can convert a Date object to this format using the
|
91
|
-
# standard
|
91
|
+
# standard
|
92
|
+
# [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
|
92
93
|
# method. In Python, a standard `datetime.datetime` object can be converted
|
93
|
-
# to this format using
|
94
|
-
#
|
95
|
-
#
|
94
|
+
# to this format using
|
95
|
+
# [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
96
|
+
# the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
97
|
+
# the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
96
98
|
# http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
|
97
99
|
# ) to obtain a formatter capable of generating timestamps in this format.
|
98
100
|
# @!attribute [rw] seconds
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright
|
1
|
+
# Copyright 2020 Google LLC
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -17,67 +17,19 @@ module Google
|
|
17
17
|
module Rpc
|
18
18
|
# The `Status` type defines a logical error model that is suitable for
|
19
19
|
# different programming environments, including REST APIs and RPC APIs. It is
|
20
|
-
# used by [gRPC](https://github.com/grpc).
|
20
|
+
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
21
|
+
# three pieces of data: error code, error message, and error details.
|
21
22
|
#
|
22
|
-
#
|
23
|
-
#
|
24
|
-
#
|
25
|
-
# = Overview
|
26
|
-
#
|
27
|
-
# The `Status` message contains three pieces of data: error code, error
|
28
|
-
# message, and error details. The error code should be an enum value of
|
29
|
-
# {Google::Rpc::Code}, but it may accept additional error codes
|
30
|
-
# if needed. The error message should be a developer-facing English message
|
31
|
-
# that helps developers *understand* and *resolve* the error. If a localized
|
32
|
-
# user-facing error message is needed, put the localized message in the error
|
33
|
-
# details or localize it in the client. The optional error details may contain
|
34
|
-
# arbitrary information about the error. There is a predefined set of error
|
35
|
-
# detail types in the package `google.rpc` that can be used for common error
|
36
|
-
# conditions.
|
37
|
-
#
|
38
|
-
# = Language mapping
|
39
|
-
#
|
40
|
-
# The `Status` message is the logical representation of the error model, but it
|
41
|
-
# is not necessarily the actual wire format. When the `Status` message is
|
42
|
-
# exposed in different client libraries and different wire protocols, it can be
|
43
|
-
# mapped differently. For example, it will likely be mapped to some exceptions
|
44
|
-
# in Java, but more likely mapped to some error codes in C.
|
45
|
-
#
|
46
|
-
# = Other uses
|
47
|
-
#
|
48
|
-
# The error model and the `Status` message can be used in a variety of
|
49
|
-
# environments, either with or without APIs, to provide a
|
50
|
-
# consistent developer experience across different environments.
|
51
|
-
#
|
52
|
-
# Example uses of this error model include:
|
53
|
-
#
|
54
|
-
# * Partial errors. If a service needs to return partial errors to the client,
|
55
|
-
# it may embed the `Status` in the normal response to indicate the partial
|
56
|
-
# errors.
|
57
|
-
#
|
58
|
-
# * Workflow errors. A typical workflow has multiple steps. Each step may
|
59
|
-
# have a `Status` message for error reporting.
|
60
|
-
#
|
61
|
-
# * Batch operations. If a client uses batch request and batch response, the
|
62
|
-
# `Status` message should be used directly inside batch response, one for
|
63
|
-
# each error sub-response.
|
64
|
-
#
|
65
|
-
# * Asynchronous operations. If an API call embeds asynchronous operation
|
66
|
-
# results in its response, the status of those operations should be
|
67
|
-
# represented directly using the `Status` message.
|
68
|
-
#
|
69
|
-
# * Logging. If some API errors are stored in logs, the message `Status` could
|
70
|
-
# be used directly after any stripping needed for security/privacy reasons.
|
23
|
+
# You can find out more about this error model and how to work with it in the
|
24
|
+
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
71
25
|
# @!attribute [rw] code
|
72
26
|
# @return [Integer]
|
73
|
-
# The status code, which should be an enum value of
|
74
|
-
# {Google::Rpc::Code}.
|
27
|
+
# The status code, which should be an enum value of {Google::Rpc::Code}.
|
75
28
|
# @!attribute [rw] message
|
76
29
|
# @return [String]
|
77
30
|
# A developer-facing error message, which should be in English. Any
|
78
31
|
# user-facing error message should be localized and sent in the
|
79
|
-
# {Google::Rpc::Status#details} field, or localized
|
80
|
-
# by the client.
|
32
|
+
# {Google::Rpc::Status#details} field, or localized by the client.
|
81
33
|
# @!attribute [rw] details
|
82
34
|
# @return [Array<Google::Protobuf::Any>]
|
83
35
|
# A list of messages that carry the error details. There is a common set of
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright
|
1
|
+
# Copyright 2020 Google LLC
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -35,20 +35,12 @@ module Google
|
|
35
35
|
module V1
|
36
36
|
# The Cloud Firestore service.
|
37
37
|
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
# every time a document is modified. Does not change when a write results
|
45
|
-
# in no modifications. Increases in a strict monotonic fashion.
|
46
|
-
# * `read_time` - The time at which a particular state was observed. Used
|
47
|
-
# to denote a consistent snapshot of the database or the time at which a
|
48
|
-
# Document was observed to not exist.
|
49
|
-
# * `commit_time` - The time at which the writes in a transaction were
|
50
|
-
# committed. Any read with an equal or greater `read_time` is guaranteed
|
51
|
-
# to see the effects of the transaction.
|
38
|
+
# Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL
|
39
|
+
# document database that simplifies storing, syncing, and querying data for
|
40
|
+
# your mobile, web, and IoT apps at global scale. Its client libraries provide
|
41
|
+
# live synchronization and offline support, while its security features and
|
42
|
+
# integrations with Firebase and Google Cloud Platform (GCP) accelerate
|
43
|
+
# building truly serverless apps.
|
52
44
|
#
|
53
45
|
# @!attribute [r] firestore_stub
|
54
46
|
# @return [Google::Firestore::V1::Firestore::Stub]
|
@@ -370,7 +362,7 @@ module Google
|
|
370
362
|
# Gets a single document.
|
371
363
|
#
|
372
364
|
# @param name [String]
|
373
|
-
# The resource name of the Document to get. In the format:
|
365
|
+
# Required. The resource name of the Document to get. In the format:
|
374
366
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
375
367
|
# @param mask [Google::Firestore::V1::DocumentMask | Hash]
|
376
368
|
# The fields to return. If not set, returns all fields.
|
@@ -421,14 +413,14 @@ module Google
|
|
421
413
|
# Lists documents.
|
422
414
|
#
|
423
415
|
# @param parent [String]
|
424
|
-
# The parent resource name. In the format:
|
416
|
+
# Required. The parent resource name. In the format:
|
425
417
|
# `projects/{project_id}/databases/{database_id}/documents` or
|
426
418
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
427
419
|
# For example:
|
428
420
|
# `projects/my-project/databases/my-database/documents` or
|
429
421
|
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
430
422
|
# @param collection_id [String]
|
431
|
-
# The collection ID, relative to `parent`, to list. For example: `chatrooms`
|
423
|
+
# Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
|
432
424
|
# or `messages`.
|
433
425
|
# @param page_size [Integer]
|
434
426
|
# The maximum number of resources contained in the underlying API
|
@@ -522,17 +514,17 @@ module Google
|
|
522
514
|
# Creates a new document.
|
523
515
|
#
|
524
516
|
# @param parent [String]
|
525
|
-
# The parent resource. For example:
|
517
|
+
# Required. The parent resource. For example:
|
526
518
|
# `projects/{project_id}/databases/{database_id}/documents` or
|
527
519
|
# `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
|
528
520
|
# @param collection_id [String]
|
529
|
-
# The collection ID, relative to `parent`, to list. For example: `chatrooms`.
|
521
|
+
# Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
|
530
522
|
# @param document_id [String]
|
531
523
|
# The client-assigned document ID to use for this document.
|
532
524
|
#
|
533
525
|
# Optional. If not specified, an ID will be assigned by the service.
|
534
526
|
# @param document [Google::Firestore::V1::Document | Hash]
|
535
|
-
# The document to create. `name` must not be set.
|
527
|
+
# Required. The document to create. `name` must not be set.
|
536
528
|
# A hash of the same form as `Google::Firestore::V1::Document`
|
537
529
|
# can also be provided.
|
538
530
|
# @param mask [Google::Firestore::V1::DocumentMask | Hash]
|
@@ -588,7 +580,7 @@ module Google
|
|
588
580
|
# Updates or inserts a document.
|
589
581
|
#
|
590
582
|
# @param document [Google::Firestore::V1::Document | Hash]
|
591
|
-
# The updated document.
|
583
|
+
# Required. The updated document.
|
592
584
|
# Creates the document if it does not already exist.
|
593
585
|
# A hash of the same form as `Google::Firestore::V1::Document`
|
594
586
|
# can also be provided.
|
@@ -654,7 +646,7 @@ module Google
|
|
654
646
|
# Deletes a document.
|
655
647
|
#
|
656
648
|
# @param name [String]
|
657
|
-
# The resource name of the Document to delete. In the format:
|
649
|
+
# Required. The resource name of the Document to delete. In the format:
|
658
650
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
659
651
|
# @param current_document [Google::Firestore::V1::Precondition | Hash]
|
660
652
|
# An optional precondition on the document.
|
@@ -695,7 +687,7 @@ module Google
|
|
695
687
|
# same order that they were requested.
|
696
688
|
#
|
697
689
|
# @param database [String]
|
698
|
-
# The database name. In the format:
|
690
|
+
# Required. The database name. In the format:
|
699
691
|
# `projects/{project_id}/databases/{database_id}`.
|
700
692
|
# @param documents [Array<String>]
|
701
693
|
# The names of the documents to retrieve. In the format:
|
@@ -765,7 +757,7 @@ module Google
|
|
765
757
|
# Starts a new transaction.
|
766
758
|
#
|
767
759
|
# @param database [String]
|
768
|
-
# The database name. In the format:
|
760
|
+
# Required. The database name. In the format:
|
769
761
|
# `projects/{project_id}/databases/{database_id}`.
|
770
762
|
# @param options_ [Google::Firestore::V1::TransactionOptions | Hash]
|
771
763
|
# The options for the transaction.
|
@@ -803,7 +795,7 @@ module Google
|
|
803
795
|
# Commits a transaction, while optionally updating documents.
|
804
796
|
#
|
805
797
|
# @param database [String]
|
806
|
-
# The database name. In the format:
|
798
|
+
# Required. The database name. In the format:
|
807
799
|
# `projects/{project_id}/databases/{database_id}`.
|
808
800
|
# @param writes [Array<Google::Firestore::V1::Write | Hash>]
|
809
801
|
# The writes to apply.
|
@@ -849,10 +841,10 @@ module Google
|
|
849
841
|
# Rolls back a transaction.
|
850
842
|
#
|
851
843
|
# @param database [String]
|
852
|
-
# The database name. In the format:
|
844
|
+
# Required. The database name. In the format:
|
853
845
|
# `projects/{project_id}/databases/{database_id}`.
|
854
846
|
# @param transaction [String]
|
855
|
-
# The transaction to roll back.
|
847
|
+
# Required. The transaction to roll back.
|
856
848
|
# @param options [Google::Gax::CallOptions]
|
857
849
|
# Overrides the default settings for this call, e.g, timeout,
|
858
850
|
# retries, etc.
|
@@ -887,7 +879,7 @@ module Google
|
|
887
879
|
# Runs a query.
|
888
880
|
#
|
889
881
|
# @param parent [String]
|
890
|
-
# The parent resource name. In the format:
|
882
|
+
# Required. The parent resource name. In the format:
|
891
883
|
# `projects/{project_id}/databases/{database_id}/documents` or
|
892
884
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
893
885
|
# For example:
|
@@ -1018,7 +1010,7 @@ module Google
|
|
1018
1010
|
# Lists all the collection IDs underneath a document.
|
1019
1011
|
#
|
1020
1012
|
# @param parent [String]
|
1021
|
-
# The parent document. In the format:
|
1013
|
+
# Required. The parent document. In the format:
|
1022
1014
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
1023
1015
|
# For example:
|
1024
1016
|
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
@@ -4,6 +4,7 @@
|
|
4
4
|
"retry_codes": {
|
5
5
|
"idempotent": [
|
6
6
|
"DEADLINE_EXCEEDED",
|
7
|
+
"INTERNAL",
|
7
8
|
"UNAVAILABLE"
|
8
9
|
],
|
9
10
|
"non_idempotent": []
|
@@ -13,18 +14,18 @@
|
|
13
14
|
"initial_retry_delay_millis": 100,
|
14
15
|
"retry_delay_multiplier": 1.3,
|
15
16
|
"max_retry_delay_millis": 60000,
|
16
|
-
"initial_rpc_timeout_millis":
|
17
|
+
"initial_rpc_timeout_millis": 60000,
|
17
18
|
"rpc_timeout_multiplier": 1.0,
|
18
|
-
"max_rpc_timeout_millis":
|
19
|
+
"max_rpc_timeout_millis": 60000,
|
19
20
|
"total_timeout_millis": 600000
|
20
21
|
},
|
21
22
|
"streaming": {
|
22
23
|
"initial_retry_delay_millis": 100,
|
23
24
|
"retry_delay_multiplier": 1.3,
|
24
25
|
"max_retry_delay_millis": 60000,
|
25
|
-
"initial_rpc_timeout_millis":
|
26
|
+
"initial_rpc_timeout_millis": 60000,
|
26
27
|
"rpc_timeout_multiplier": 1.0,
|
27
|
-
"max_rpc_timeout_millis":
|
28
|
+
"max_rpc_timeout_millis": 60000,
|
28
29
|
"total_timeout_millis": 600000
|
29
30
|
}
|
30
31
|
},
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright
|
1
|
+
# Copyright 2020 Google LLC
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -81,20 +81,12 @@ module Google
|
|
81
81
|
##
|
82
82
|
# The Cloud Firestore service.
|
83
83
|
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
# every time a document is modified. Does not change when a write results
|
91
|
-
# in no modifications. Increases in a strict monotonic fashion.
|
92
|
-
# * `read_time` - The time at which a particular state was observed. Used
|
93
|
-
# to denote a consistent snapshot of the database or the time at which a
|
94
|
-
# Document was observed to not exist.
|
95
|
-
# * `commit_time` - The time at which the writes in a transaction were
|
96
|
-
# committed. Any read with an equal or greater `read_time` is guaranteed
|
97
|
-
# to see the effects of the transaction.
|
84
|
+
# Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL
|
85
|
+
# document database that simplifies storing, syncing, and querying data for
|
86
|
+
# your mobile, web, and IoT apps at global scale. Its client libraries provide
|
87
|
+
# live synchronization and offline support, while its security features and
|
88
|
+
# integrations with Firebase and Google Cloud Platform (GCP) accelerate
|
89
|
+
# building truly serverless apps.
|
98
90
|
#
|
99
91
|
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
|
100
92
|
# Provides the means for authenticating requests made by the client. This parameter can
|