google-cloud-firestore 0.23.0 → 0.24.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.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +10 -2
  3. data/README.md +4 -4
  4. data/lib/google-cloud-firestore.rb +5 -4
  5. data/lib/google/cloud/firestore.rb +2 -505
  6. data/lib/google/cloud/firestore/client.rb +50 -0
  7. data/lib/google/cloud/firestore/convert.rb +69 -50
  8. data/lib/google/cloud/firestore/field_value.rb +96 -1
  9. data/lib/google/cloud/firestore/query.rb +34 -14
  10. data/lib/google/cloud/firestore/v1beta1.rb +6 -0
  11. data/lib/google/cloud/firestore/v1beta1/credentials.rb +1 -0
  12. data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/common.rb +1 -0
  13. data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/document.rb +3 -2
  14. data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb +21 -20
  15. data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb +1 -0
  16. data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb +2 -1
  17. data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/any.rb +14 -8
  18. data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/empty.rb +1 -0
  19. data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/timestamp.rb +9 -6
  20. data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/wrappers.rb +1 -0
  21. data/lib/google/cloud/firestore/v1beta1/doc/google/rpc/status.rb +1 -0
  22. data/lib/google/cloud/firestore/v1beta1/firestore_client.rb +16 -14
  23. data/lib/google/cloud/firestore/version.rb +1 -1
  24. data/lib/google/firestore/v1beta1/common_pb.rb +1 -0
  25. data/lib/google/firestore/v1beta1/document_pb.rb +1 -0
  26. data/lib/google/firestore/v1beta1/firestore_pb.rb +1 -0
  27. data/lib/google/firestore/v1beta1/firestore_services_pb.rb +1 -0
  28. data/lib/google/firestore/v1beta1/query_pb.rb +1 -0
  29. data/lib/google/firestore/v1beta1/write_pb.rb +1 -0
  30. metadata +6 -6
data/lib/google/cloud/firestore/v1beta1.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  require "google/cloud/firestore/v1beta1/firestore_client"
16
17
 
17
18
  module Google
@@ -35,6 +36,11 @@ module Google
35
36
  # 3. [Enable the Google Cloud Firestore API.](https://console.cloud.google.com/apis/library/firestore.googleapis.com)
36
37
  # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
37
38
  #
39
+ # ### Installation
40
+ # ```
41
+ # $ gem install google-cloud-firestore
42
+ # ```
43
+ #
38
44
  # ### Next Steps
39
45
  # - Read the [Google Cloud Firestore API Product documentation][Product Documentation]
40
46
  # to learn more about the product and see How-to Guides.
data/lib/google/cloud/firestore/v1beta1/credentials.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  require "googleauth"
16
17
 
17
18
  module Google
data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/common.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Firestore
17
18
  module V1beta1
data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/document.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Firestore
17
18
  module V1beta1
@@ -21,7 +22,7 @@ module Google
21
22
  # @!attribute [rw] name
22
23
  # @return [String]
23
24
  # The resource name of the document, for example
24
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
25
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
25
26
  # @!attribute [rw] fields
26
27
  # @return [Hash{String => Google::Firestore::V1beta1::Value}]
27
28
  # The document's fields.
@@ -99,7 +100,7 @@ module Google
99
100
  # @!attribute [rw] reference_value
100
101
  # @return [String]
101
102
  # A reference to a document. For example:
102
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
103
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
103
104
  # @!attribute [rw] geo_point_value
104
105
  # @return [Google::Type::LatLng]
105
106
  # A geo point value representing a point on the surface of Earth.
data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Firestore
17
18
  module V1beta1
@@ -19,7 +20,7 @@ module Google
19
20
  # @!attribute [rw] name
20
21
  # @return [String]
21
22
  # The resource name of the Document to get. In the format:
22
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
23
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
23
24
  # @!attribute [rw] mask
24
25
  # @return [Google::Firestore::V1beta1::DocumentMask]
25
26
  # The fields to return. If not set, returns all fields.
@@ -39,8 +40,8 @@ module Google
39
40
  # @!attribute [rw] parent
40
41
  # @return [String]
41
42
  # The parent resource name. In the format:
42
- # +projects/{project_id}/databases/{database_id}/documents+ or
43
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
43
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
44
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
44
45
  # For example:
45
46
  # +projects/my-project/databases/my-database/documents+ or
46
47
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
@@ -94,8 +95,8 @@ module Google
94
95
  # @!attribute [rw] parent
95
96
  # @return [String]
96
97
  # The parent resource. For example:
97
- # +projects/{project_id}/databases/{database_id}/documents+ or
98
- # +projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}+
98
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
99
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/chatrooms/\\{chatroom_id}+
99
100
  # @!attribute [rw] collection_id
100
101
  # @return [String]
101
102
  # The collection ID, relative to +parent+, to list. For example: +chatrooms+.
@@ -145,7 +146,7 @@ module Google
145
146
  # @!attribute [rw] name
146
147
  # @return [String]
147
148
  # The resource name of the Document to delete. In the format:
148
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
149
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
149
150
  # @!attribute [rw] current_document
150
151
  # @return [Google::Firestore::V1beta1::Precondition]
151
152
  # An optional precondition on the document.
@@ -156,11 +157,11 @@ module Google
156
157
  # @!attribute [rw] database
157
158
  # @return [String]
158
159
  # The database name. In the format:
159
- # +projects/{project_id}/databases/{database_id}+.
160
+ # +projects/\\{project_id}/databases/\\{database_id}+.
160
161
  # @!attribute [rw] documents
161
162
  # @return [Array<String>]
162
163
  # The names of the documents to retrieve. In the format:
163
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
164
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
164
165
  # The request will fail if any of the document is not a child resource of the
165
166
  # given +database+. Duplicate names will be elided.
166
167
  # @!attribute [rw] mask
@@ -191,7 +192,7 @@ module Google
191
192
  # @!attribute [rw] missing
192
193
  # @return [String]
193
194
  # A document name that was requested but does not exist. In the format:
194
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
195
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
195
196
  # @!attribute [rw] transaction
196
197
  # @return [String]
197
198
  # The transaction that was started as part of this request.
@@ -209,7 +210,7 @@ module Google
209
210
  # @!attribute [rw] database
210
211
  # @return [String]
211
212
  # The database name. In the format:
212
- # +projects/{project_id}/databases/{database_id}+.
213
+ # +projects/\\{project_id}/databases/\\{database_id}+.
213
214
  # @!attribute [rw] options
214
215
  # @return [Google::Firestore::V1beta1::TransactionOptions]
215
216
  # The options for the transaction.
@@ -226,7 +227,7 @@ module Google
226
227
  # @!attribute [rw] database
227
228
  # @return [String]
228
229
  # The database name. In the format:
229
- # +projects/{project_id}/databases/{database_id}+.
230
+ # +projects/\\{project_id}/databases/\\{database_id}+.
230
231
  # @!attribute [rw] writes
231
232
  # @return [Array<Google::Firestore::V1beta1::Write>]
232
233
  # The writes to apply.
@@ -253,7 +254,7 @@ module Google
253
254
  # @!attribute [rw] database
254
255
  # @return [String]
255
256
  # The database name. In the format:
256
- # +projects/{project_id}/databases/{database_id}+.
257
+ # +projects/\\{project_id}/databases/\\{database_id}+.
257
258
  # @!attribute [rw] transaction
258
259
  # @return [String]
259
260
  # The transaction to roll back.
@@ -263,8 +264,8 @@ module Google
263
264
  # @!attribute [rw] parent
264
265
  # @return [String]
265
266
  # The parent resource name. In the format:
266
- # +projects/{project_id}/databases/{database_id}/documents+ or
267
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
267
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
268
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
268
269
  # For example:
269
270
  # +projects/my-project/databases/my-database/documents+ or
270
271
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
@@ -325,7 +326,7 @@ module Google
325
326
  # @!attribute [rw] database
326
327
  # @return [String]
327
328
  # The database name. In the format:
328
- # +projects/{project_id}/databases/{database_id}+.
329
+ # +projects/\\{project_id}/databases/\\{database_id}+.
329
330
  # This is only required in the first message.
330
331
  # @!attribute [rw] stream_id
331
332
  # @return [String]
@@ -387,7 +388,7 @@ module Google
387
388
  # @!attribute [rw] database
388
389
  # @return [String]
389
390
  # The database name. In the format:
390
- # +projects/{project_id}/databases/{database_id}+.
391
+ # +projects/\\{project_id}/databases/\\{database_id}+.
391
392
  # @!attribute [rw] add_target
392
393
  # @return [Google::Firestore::V1beta1::Target]
393
394
  # A target to add to this stream.
@@ -457,7 +458,7 @@ module Google
457
458
  # @!attribute [rw] documents
458
459
  # @return [Array<String>]
459
460
  # The names of the documents to retrieve. In the format:
460
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
461
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
461
462
  # The request will fail if any of the document is not a child resource of
462
463
  # the given +database+. Duplicate names will be elided.
463
464
  class DocumentsTarget; end
@@ -466,8 +467,8 @@ module Google
466
467
  # @!attribute [rw] parent
467
468
  # @return [String]
468
469
  # The parent resource name. In the format:
469
- # +projects/{project_id}/databases/{database_id}/documents+ or
470
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
470
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
471
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
471
472
  # For example:
472
473
  # +projects/my-project/databases/my-database/documents+ or
473
474
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
@@ -548,7 +549,7 @@ module Google
548
549
  # @!attribute [rw] parent
549
550
  # @return [String]
550
551
  # The parent document. In the format:
551
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
552
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
552
553
  # For example:
553
554
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
554
555
  # @!attribute [rw] page_size
data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Firestore
17
18
  module V1beta1
data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Firestore
17
18
  module V1beta1
@@ -22,7 +23,7 @@ module Google
22
23
  # @!attribute [rw] delete
23
24
  # @return [String]
24
25
  # A document name to delete. In the format:
25
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
26
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
26
27
  # @!attribute [rw] transform
27
28
  # @return [Google::Firestore::V1beta1::DocumentTransform]
28
29
  # Applies a tranformation to a document.
data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/any.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Protobuf
17
18
  # +Any+ contains an arbitrary serialized protocol buffer message along with a
@@ -95,17 +96,18 @@ module Google
95
96
  # }
96
97
  # @!attribute [rw] type_url
97
98
  # @return [String]
98
- # A URL/resource name whose content describes the type of the
99
- # serialized protocol buffer message.
99
+ # A URL/resource name that uniquely identifies the type of the serialized
100
+ # protocol buffer message. The last segment of the URL's path must represent
101
+ # the fully qualified name of the type (as in
102
+ # +path/google.protobuf.Duration+). The name should be in a canonical form
103
+ # (e.g., leading "." is not accepted).
100
104
  #
101
- # For URLs which use the scheme +http+, +https+, or no scheme, the
102
- # following restrictions and interpretations apply:
105
+ # In practice, teams usually precompile into the binary all types that they
106
+ # expect it to use in the context of Any. However, for URLs which use the
107
+ # scheme +http+, +https+, or no scheme, one can optionally set up a type
108
+ # server that maps type URLs to message definitions as follows:
103
109
  #
104
110
  # * If no scheme is provided, +https+ is assumed.
105
- # * The last segment of the URL's path must represent the fully
106
- # qualified name of the type (as in +path/google.protobuf.Duration+).
107
- # The name should be in a canonical form (e.g., leading "." is
108
- # not accepted).
109
111
  # * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
110
112
  # value in binary format, or produce an error.
111
113
  # * Applications are allowed to cache lookup results based on the
@@ -114,6 +116,10 @@ module Google
114
116
  # on changes to types. (Use versioned type names to manage
115
117
  # breaking changes.)
116
118
  #
119
+ # Note: this functionality is not currently available in the official
120
+ # protobuf release, and it is not used for type URLs beginning with
121
+ # type.googleapis.com.
122
+ #
117
123
  # Schemes other than +http+, +https+ (or the empty scheme) might be
118
124
  # used with implementation specific semantics.
119
125
  # @!attribute [rw] value
data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/empty.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Protobuf
17
18
  # A generic empty message that you can re-use to avoid defining duplicated
data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/timestamp.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Protobuf
17
18
  # A Timestamp represents a point in time independent of any time zone
@@ -72,12 +73,14 @@ module Google
72
73
  #
73
74
  # In JSON format, the Timestamp type is encoded as a string in the
74
75
  # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
75
- # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
76
- # where {year} is always expressed using four digits while {month}, {day},
77
- # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
76
+ # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
77
+ # where \\{year} is always expressed using four digits while \\{month}, \\{day},
78
+ # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
78
79
  # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
79
80
  # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
80
- # is required, though only UTC (as indicated by "Z") is presently supported.
81
+ # is required. A proto3 JSON serializer should always use UTC (as indicated by
82
+ # "Z") when printing the Timestamp type and a proto3 JSON parser should be
83
+ # able to accept both UTC and other timezones (as indicated by an offset).
81
84
  #
82
85
  # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
83
86
  # 01:30 UTC on January 15, 2017.
@@ -88,8 +91,8 @@ module Google
88
91
  # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
89
92
  # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
90
93
  # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
91
- # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
92
- # to obtain a formatter capable of generating timestamps in this format.
94
+ # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
95
+ # ) to obtain a formatter capable of generating timestamps in this format.
93
96
  # @!attribute [rw] seconds
94
97
  # @return [Integer]
95
98
  # Represents seconds of UTC time since Unix epoch
data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/wrappers.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Protobuf
17
18
  # Wrapper message for +double+.
data/lib/google/cloud/firestore/v1beta1/doc/google/rpc/status.rb CHANGED
@@ -12,6 +12,7 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
+
15
16
  module Google
16
17
  module Rpc
17
18
  # The +Status+ type defines a logical error model that is suitable for different
data/lib/google/cloud/firestore/v1beta1/firestore_client.rb CHANGED
@@ -19,6 +19,7 @@
19
19
  # For the short term, the refresh process will only be runnable by Google
20
20
  # engineers.
21
21
 
22
+
22
23
  require "json"
23
24
  require "pathname"
24
25
 
@@ -51,6 +52,7 @@ module Google
51
52
  # @!attribute [r] firestore_stub
52
53
  # @return [Google::Firestore::V1beta1::Firestore::Stub]
53
54
  class FirestoreClient
55
+ # @private
54
56
  attr_reader :firestore_stub
55
57
 
56
58
  # The default address of the service.
@@ -335,7 +337,7 @@ module Google
335
337
  #
336
338
  # @param name [String]
337
339
  # The resource name of the Document to get. In the format:
338
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
340
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
339
341
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
340
342
  # The fields to return. If not set, returns all fields.
341
343
  #
@@ -386,8 +388,8 @@ module Google
386
388
  #
387
389
  # @param parent [String]
388
390
  # The parent resource name. In the format:
389
- # +projects/{project_id}/databases/{database_id}/documents+ or
390
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
391
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
392
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
391
393
  # For example:
392
394
  # +projects/my-project/databases/my-database/documents+ or
393
395
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
@@ -487,8 +489,8 @@ module Google
487
489
  #
488
490
  # @param parent [String]
489
491
  # The parent resource. For example:
490
- # +projects/{project_id}/databases/{database_id}/documents+ or
491
- # +projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}+
492
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
493
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/chatrooms/\\{chatroom_id}+
492
494
  # @param collection_id [String]
493
495
  # The collection ID, relative to +parent+, to list. For example: +chatrooms+.
494
496
  # @param document_id [String]
@@ -619,7 +621,7 @@ module Google
619
621
  #
620
622
  # @param name [String]
621
623
  # The resource name of the Document to delete. In the format:
622
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
624
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
623
625
  # @param current_document [Google::Firestore::V1beta1::Precondition | Hash]
624
626
  # An optional precondition on the document.
625
627
  # The request will fail if this is set and not met by the target document.
@@ -660,10 +662,10 @@ module Google
660
662
  #
661
663
  # @param database [String]
662
664
  # The database name. In the format:
663
- # +projects/{project_id}/databases/{database_id}+.
665
+ # +projects/\\{project_id}/databases/\\{database_id}+.
664
666
  # @param documents [Array<String>]
665
667
  # The names of the documents to retrieve. In the format:
666
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
668
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
667
669
  # The request will fail if any of the document is not a child resource of the
668
670
  # given +database+. Duplicate names will be elided.
669
671
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
@@ -730,7 +732,7 @@ module Google
730
732
  #
731
733
  # @param database [String]
732
734
  # The database name. In the format:
733
- # +projects/{project_id}/databases/{database_id}+.
735
+ # +projects/\\{project_id}/databases/\\{database_id}+.
734
736
  # @param options_ [Google::Firestore::V1beta1::TransactionOptions | Hash]
735
737
  # The options for the transaction.
736
738
  # Defaults to a read-write transaction.
@@ -768,7 +770,7 @@ module Google
768
770
  #
769
771
  # @param database [String]
770
772
  # The database name. In the format:
771
- # +projects/{project_id}/databases/{database_id}+.
773
+ # +projects/\\{project_id}/databases/\\{database_id}+.
772
774
  # @param writes [Array<Google::Firestore::V1beta1::Write | Hash>]
773
775
  # The writes to apply.
774
776
  #
@@ -814,7 +816,7 @@ module Google
814
816
  #
815
817
  # @param database [String]
816
818
  # The database name. In the format:
817
- # +projects/{project_id}/databases/{database_id}+.
819
+ # +projects/\\{project_id}/databases/\\{database_id}+.
818
820
  # @param transaction [String]
819
821
  # The transaction to roll back.
820
822
  # @param options [Google::Gax::CallOptions]
@@ -852,8 +854,8 @@ module Google
852
854
  #
853
855
  # @param parent [String]
854
856
  # The parent resource name. In the format:
855
- # +projects/{project_id}/databases/{database_id}/documents+ or
856
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
857
+ # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
858
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
857
859
  # For example:
858
860
  # +projects/my-project/databases/my-database/documents+ or
859
861
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
@@ -983,7 +985,7 @@ module Google
983
985
  #
984
986
  # @param parent [String]
985
987
  # The parent document. In the format:
986
- # +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
988
+ # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
987
989
  # For example:
988
990
  # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
989
991
  # @param page_size [Integer]