google-cloud-firestore 0.24.1 → 0.24.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -32,20 +32,20 @@ module Google
32
32
  #
33
33
  # Firestore guarantees a stable ordering through the following rules:
34
34
  #
35
- # * Any field required to appear in +order_by+, that is not already
36
- # specified in +order_by+, is appended to the order in field name order
35
+ # * Any field required to appear in `order_by`, that is not already
36
+ # specified in `order_by`, is appended to the order in field name order
37
37
  # by default.
38
- # * If an order on +__name__+ is not specified, it is appended by default.
38
+ # * If an order on `__name__` is not specified, it is appended by default.
39
39
  #
40
40
  # Fields are appended with the same sort direction as the last order
41
41
  # specified, or 'ASCENDING' if no order was specified. For example:
42
42
  #
43
- # * +SELECT * FROM Foo ORDER BY A+ becomes
44
- # +SELECT * FROM Foo ORDER BY A, __name__+
45
- # * +SELECT * FROM Foo ORDER BY A DESC+ becomes
46
- # +SELECT * FROM Foo ORDER BY A DESC, __name__ DESC+
47
- # * +SELECT * FROM Foo WHERE A > 1+ becomes
48
- # +SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__+
43
+ # * `SELECT * FROM Foo ORDER BY A` becomes
44
+ # `SELECT * FROM Foo ORDER BY A, __name__`
45
+ # * `SELECT * FROM Foo ORDER BY A DESC` becomes
46
+ # `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
47
+ # * `SELECT * FROM Foo WHERE A > 1` becomes
48
+ # `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
49
49
  # @!attribute [rw] start_at
50
50
  # @return [Google::Firestore::V1beta1::Cursor]
51
51
  # A starting point for the query results.
@@ -65,7 +65,7 @@ module Google
65
65
  # Applies after all other constraints.
66
66
  # Must be >= 0 if specified.
67
67
  class StructuredQuery
68
- # A selection of a collection, such as +messages as m1+.
68
+ # A selection of a collection, such as `messages as m1`.
69
69
  # @!attribute [rw] collection_id
70
70
  # @return [String]
71
71
  # The collection ID.
@@ -73,7 +73,7 @@ module Google
73
73
  # @!attribute [rw] all_descendants
74
74
  # @return [true, false]
75
75
  # When false, selects only collections that are immediate children of
76
- # the +parent+ specified in the containing +RunQueryRequest+.
76
+ # the `parent` specified in the containing `RunQueryRequest`.
77
77
  # When true, selects all descendant collections.
78
78
  class CollectionSelector; end
79
79
 
@@ -124,17 +124,17 @@ module Google
124
124
  # Unspecified. This value must not be used.
125
125
  OPERATOR_UNSPECIFIED = 0
126
126
 
127
- # Less than. Requires that the field come first in +order_by+.
127
+ # Less than. Requires that the field come first in `order_by`.
128
128
  LESS_THAN = 1
129
129
 
130
- # Less than or equal. Requires that the field come first in +order_by+.
130
+ # Less than or equal. Requires that the field come first in `order_by`.
131
131
  LESS_THAN_OR_EQUAL = 2
132
132
 
133
- # Greater than. Requires that the field come first in +order_by+.
133
+ # Greater than. Requires that the field come first in `order_by`.
134
134
  GREATER_THAN = 3
135
135
 
136
136
  # Greater than or equal. Requires that the field come first in
137
- # +order_by+.
137
+ # `order_by`.
138
138
  GREATER_THAN_OR_EQUAL = 4
139
139
 
140
140
  # Equal.
@@ -172,10 +172,10 @@ module Google
172
172
  # The field to order by.
173
173
  # @!attribute [rw] direction
174
174
  # @return [Google::Firestore::V1beta1::StructuredQuery::Direction]
175
- # The direction to order by. Defaults to +ASCENDING+.
175
+ # The direction to order by. Defaults to `ASCENDING`.
176
176
  class Order; end
177
177
 
178
- # A reference to a field, such as +max(messages.time) as max_time+.
178
+ # A reference to a field, such as `max(messages.time) as max_time`.
179
179
  # @!attribute [rw] field_path
180
180
  # @return [String]
181
181
  class FieldReference; end
@@ -186,7 +186,7 @@ module Google
186
186
  # The fields to return.
187
187
  #
188
188
  # If empty, all fields are returned. To only return the name
189
- # of the document, use +['__name__']+.
189
+ # of the document, use `['__name__']`.
190
190
  class Projection; end
191
191
 
192
192
  # A sort direction.
@@ -23,19 +23,19 @@ module Google
23
23
  # @!attribute [rw] delete
24
24
  # @return [String]
25
25
  # A document name to delete. In the format:
26
- # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
26
+ # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
27
27
  # @!attribute [rw] transform
28
28
  # @return [Google::Firestore::V1beta1::DocumentTransform]
29
29
  # Applies a tranformation to a document.
30
- # At most one +transform+ per document is allowed in a given request.
31
- # An +update+ cannot follow a +transform+ on the same document in a given
30
+ # At most one `transform` per document is allowed in a given request.
31
+ # An `update` cannot follow a `transform` on the same document in a given
32
32
  # request.
33
33
  # @!attribute [rw] update_mask
34
34
  # @return [Google::Firestore::V1beta1::DocumentMask]
35
35
  # The fields to update in this write.
36
36
  #
37
- # This field can be set only when the operation is +update+.
38
- # If the mask is not set for an +update+ and the document exists, any
37
+ # This field can be set only when the operation is `update`.
38
+ # If the mask is not set for an `update` and the document exists, any
39
39
  # existing data will be overwritten.
40
40
  # If the mask is set and the document on the server has fields not covered by
41
41
  # the mask, they are left unchanged.
@@ -110,7 +110,7 @@ module Google
110
110
  # @!attribute [rw] update_time
111
111
  # @return [Google::Protobuf::Timestamp]
112
112
  # The last update time of the document after applying the write. Not set
113
- # after a +delete+.
113
+ # after a `delete`.
114
114
  #
115
115
  # If the write did not actually change the document, this will be the
116
116
  # previous update_time.
@@ -131,7 +131,7 @@ module Google
131
131
  # @return [Google::Firestore::V1beta1::Document]
132
132
  # The new state of the {Google::Firestore::V1beta1::Document Document}.
133
133
  #
134
- # If +mask+ is set, contains only fields that were updated or added.
134
+ # If `mask` is set, contains only fields that were updated or added.
135
135
  # @!attribute [rw] target_ids
136
136
  # @return [Array<Integer>]
137
137
  # A set of target IDs of targets that match this document.
@@ -157,7 +157,7 @@ module Google
157
157
  # @return [Google::Protobuf::Timestamp]
158
158
  # The read timestamp at which the delete was observed.
159
159
  #
160
- # Greater or equal to the +commit_time+ of the delete.
160
+ # Greater or equal to the `commit_time` of the delete.
161
161
  class DocumentDelete; end
162
162
 
163
163
  # A {Google::Firestore::V1beta1::Document Document} has been removed from the view of the targets.
@@ -178,7 +178,7 @@ module Google
178
178
  # @return [Google::Protobuf::Timestamp]
179
179
  # The read timestamp at which the remove was observed.
180
180
  #
181
- # Greater or equal to the +commit_time+ of the change/delete/remove.
181
+ # Greater or equal to the `commit_time` of the change/delete/remove.
182
182
  class DocumentRemove; end
183
183
 
184
184
  # A digest of all the documents that match a given target.
@@ -15,7 +15,7 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +Any+ contains an arbitrary serialized protocol buffer message along with a
18
+ # `Any` contains an arbitrary serialized protocol buffer message along with a
19
19
  # URL that describes the type of the serialized message.
20
20
  #
21
21
  # Protobuf library provides support to pack/unpack Any values in the form
@@ -69,9 +69,9 @@ module Google
69
69
  #
70
70
  # = JSON
71
71
  #
72
- # The JSON representation of an +Any+ value uses the regular
72
+ # The JSON representation of an `Any` value uses the regular
73
73
  # representation of the deserialized, embedded message, with an
74
- # additional field +@type+ which contains the type URL. Example:
74
+ # additional field `@type` which contains the type URL. Example:
75
75
  #
76
76
  # package google.profile;
77
77
  # message Person {
@@ -87,7 +87,7 @@ module Google
87
87
  #
88
88
  # If the embedded message type is well-known and has a custom JSON
89
89
  # representation, that representation will be embedded adding a field
90
- # +value+ which holds the custom JSON in addition to the +@type+
90
+ # `value` which holds the custom JSON in addition to the `@type`
91
91
  # field. Example (for message {Google::Protobuf::Duration}):
92
92
  #
93
93
  # {
@@ -99,15 +99,15 @@ module Google
99
99
  # A URL/resource name that uniquely identifies the type of the serialized
100
100
  # protocol buffer message. The last segment of the URL's path must represent
101
101
  # the fully qualified name of the type (as in
102
- # +path/google.protobuf.Duration+). The name should be in a canonical form
102
+ # `path/google.protobuf.Duration`). The name should be in a canonical form
103
103
  # (e.g., leading "." is not accepted).
104
104
  #
105
105
  # In practice, teams usually precompile into the binary all types that they
106
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
107
+ # scheme `http`, `https`, or no scheme, one can optionally set up a type
108
108
  # server that maps type URLs to message definitions as follows:
109
109
  #
110
- # * If no scheme is provided, +https+ is assumed.
110
+ # * If no scheme is provided, `https` is assumed.
111
111
  # * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
112
112
  # value in binary format, or produce an error.
113
113
  # * Applications are allowed to cache lookup results based on the
@@ -120,7 +120,7 @@ module Google
120
120
  # protobuf release, and it is not used for type URLs beginning with
121
121
  # type.googleapis.com.
122
122
  #
123
- # Schemes other than +http+, +https+ (or the empty scheme) might be
123
+ # Schemes other than `http`, `https` (or the empty scheme) might be
124
124
  # used with implementation specific semantics.
125
125
  # @!attribute [rw] value
126
126
  # @return [String]
@@ -23,7 +23,7 @@ module Google
23
23
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
24
24
  # }
25
25
  #
26
- # The JSON representation for +Empty+ is empty JSON object +{}+.
26
+ # The JSON representation for `Empty` is empty JSON object `{}`.
27
27
  class Empty; end
28
28
  end
29
29
  end
@@ -29,13 +29,13 @@ module Google
29
29
  #
30
30
  # = Examples
31
31
  #
32
- # Example 1: Compute Timestamp from POSIX +time()+.
32
+ # Example 1: Compute Timestamp from POSIX `time()`.
33
33
  #
34
34
  # Timestamp timestamp;
35
35
  # timestamp.set_seconds(time(NULL));
36
36
  # timestamp.set_nanos(0);
37
37
  #
38
- # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
38
+ # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
39
39
  #
40
40
  # struct timeval tv;
41
41
  # gettimeofday(&tv, NULL);
@@ -44,7 +44,7 @@ module Google
44
44
  # timestamp.set_seconds(tv.tv_sec);
45
45
  # timestamp.set_nanos(tv.tv_usec * 1000);
46
46
  #
47
- # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
47
+ # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
48
48
  #
49
49
  # FILETIME ft;
50
50
  # GetSystemTimeAsFileTime(&ft);
@@ -56,7 +56,7 @@ module Google
56
56
  # timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
57
57
  # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
58
58
  #
59
- # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
59
+ # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
60
60
  #
61
61
  # long millis = System.currentTimeMillis();
62
62
  #
@@ -87,10 +87,10 @@ module Google
87
87
  #
88
88
  # In JavaScript, one can convert a Date object to this format using the
89
89
  # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
90
- # method. In Python, a standard +datetime.datetime+ object can be converted
91
- # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
90
+ # method. In Python, a standard `datetime.datetime` object can be converted
91
+ # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
92
92
  # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
93
- # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
93
+ # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
94
94
  # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
95
95
  # ) to obtain a formatter capable of generating timestamps in this format.
96
96
  # @!attribute [rw] seconds
@@ -15,73 +15,73 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # Wrapper message for +double+.
18
+ # Wrapper message for `double`.
19
19
  #
20
- # The JSON representation for +DoubleValue+ is JSON number.
20
+ # The JSON representation for `DoubleValue` is JSON number.
21
21
  # @!attribute [rw] value
22
22
  # @return [Float]
23
23
  # The double value.
24
24
  class DoubleValue; end
25
25
 
26
- # Wrapper message for +float+.
26
+ # Wrapper message for `float`.
27
27
  #
28
- # The JSON representation for +FloatValue+ is JSON number.
28
+ # The JSON representation for `FloatValue` is JSON number.
29
29
  # @!attribute [rw] value
30
30
  # @return [Float]
31
31
  # The float value.
32
32
  class FloatValue; end
33
33
 
34
- # Wrapper message for +int64+.
34
+ # Wrapper message for `int64`.
35
35
  #
36
- # The JSON representation for +Int64Value+ is JSON string.
36
+ # The JSON representation for `Int64Value` is JSON string.
37
37
  # @!attribute [rw] value
38
38
  # @return [Integer]
39
39
  # The int64 value.
40
40
  class Int64Value; end
41
41
 
42
- # Wrapper message for +uint64+.
42
+ # Wrapper message for `uint64`.
43
43
  #
44
- # The JSON representation for +UInt64Value+ is JSON string.
44
+ # The JSON representation for `UInt64Value` is JSON string.
45
45
  # @!attribute [rw] value
46
46
  # @return [Integer]
47
47
  # The uint64 value.
48
48
  class UInt64Value; end
49
49
 
50
- # Wrapper message for +int32+.
50
+ # Wrapper message for `int32`.
51
51
  #
52
- # The JSON representation for +Int32Value+ is JSON number.
52
+ # The JSON representation for `Int32Value` is JSON number.
53
53
  # @!attribute [rw] value
54
54
  # @return [Integer]
55
55
  # The int32 value.
56
56
  class Int32Value; end
57
57
 
58
- # Wrapper message for +uint32+.
58
+ # Wrapper message for `uint32`.
59
59
  #
60
- # The JSON representation for +UInt32Value+ is JSON number.
60
+ # The JSON representation for `UInt32Value` is JSON number.
61
61
  # @!attribute [rw] value
62
62
  # @return [Integer]
63
63
  # The uint32 value.
64
64
  class UInt32Value; end
65
65
 
66
- # Wrapper message for +bool+.
66
+ # Wrapper message for `bool`.
67
67
  #
68
- # The JSON representation for +BoolValue+ is JSON +true+ and +false+.
68
+ # The JSON representation for `BoolValue` is JSON `true` and `false`.
69
69
  # @!attribute [rw] value
70
70
  # @return [true, false]
71
71
  # The bool value.
72
72
  class BoolValue; end
73
73
 
74
- # Wrapper message for +string+.
74
+ # Wrapper message for `string`.
75
75
  #
76
- # The JSON representation for +StringValue+ is JSON string.
76
+ # The JSON representation for `StringValue` is JSON string.
77
77
  # @!attribute [rw] value
78
78
  # @return [String]
79
79
  # The string value.
80
80
  class StringValue; end
81
81
 
82
- # Wrapper message for +bytes+.
82
+ # Wrapper message for `bytes`.
83
83
  #
84
- # The JSON representation for +BytesValue+ is JSON string.
84
+ # The JSON representation for `BytesValue` is JSON string.
85
85
  # @!attribute [rw] value
86
86
  # @return [String]
87
87
  # The bytes value.
@@ -15,7 +15,7 @@
15
15
 
16
16
  module Google
17
17
  module Rpc
18
- # The +Status+ type defines a logical error model that is suitable for different
18
+ # The `Status` type defines a logical error model that is suitable for different
19
19
  # programming environments, including REST APIs and RPC APIs. It is used by
20
20
  # [gRPC](https://github.com/grpc). The error model is designed to be:
21
21
  #
@@ -24,7 +24,7 @@ module Google
24
24
  #
25
25
  # = Overview
26
26
  #
27
- # The +Status+ message contains three pieces of data: error code, error message,
27
+ # The `Status` message contains three pieces of data: error code, error message,
28
28
  # and error details. The error code should be an enum value of
29
29
  # {Google::Rpc::Code}, but it may accept additional error codes if needed. The
30
30
  # error message should be a developer-facing English message that helps
@@ -32,40 +32,40 @@ module Google
32
32
  # error message is needed, put the localized message in the error details or
33
33
  # localize it in the client. The optional error details may contain arbitrary
34
34
  # information about the error. There is a predefined set of error detail types
35
- # in the package +google.rpc+ that can be used for common error conditions.
35
+ # in the package `google.rpc` that can be used for common error conditions.
36
36
  #
37
37
  # = Language mapping
38
38
  #
39
- # The +Status+ message is the logical representation of the error model, but it
40
- # is not necessarily the actual wire format. When the +Status+ message is
39
+ # The `Status` message is the logical representation of the error model, but it
40
+ # is not necessarily the actual wire format. When the `Status` message is
41
41
  # exposed in different client libraries and different wire protocols, it can be
42
42
  # mapped differently. For example, it will likely be mapped to some exceptions
43
43
  # in Java, but more likely mapped to some error codes in C.
44
44
  #
45
45
  # = Other uses
46
46
  #
47
- # The error model and the +Status+ message can be used in a variety of
47
+ # The error model and the `Status` message can be used in a variety of
48
48
  # environments, either with or without APIs, to provide a
49
49
  # consistent developer experience across different environments.
50
50
  #
51
51
  # Example uses of this error model include:
52
52
  #
53
53
  # * Partial errors. If a service needs to return partial errors to the client,
54
- # it may embed the +Status+ in the normal response to indicate the partial
54
+ # it may embed the `Status` in the normal response to indicate the partial
55
55
  # errors.
56
56
  #
57
57
  # * Workflow errors. A typical workflow has multiple steps. Each step may
58
- # have a +Status+ message for error reporting.
58
+ # have a `Status` message for error reporting.
59
59
  #
60
60
  # * Batch operations. If a client uses batch request and batch response, the
61
- # +Status+ message should be used directly inside batch response, one for
61
+ # `Status` message should be used directly inside batch response, one for
62
62
  # each error sub-response.
63
63
  #
64
64
  # * Asynchronous operations. If an API call embeds asynchronous operation
65
65
  # results in its response, the status of those operations should be
66
- # represented directly using the +Status+ message.
66
+ # represented directly using the `Status` message.
67
67
  #
68
- # * Logging. If some API errors are stored in logs, the message +Status+ could
68
+ # * Logging. If some API errors are stored in logs, the message `Status` could
69
69
  # be used directly after any stripping needed for security/privacy reasons.
70
70
  # @!attribute [rw] code
71
71
  # @return [Integer]
@@ -36,17 +36,17 @@ module Google
36
36
  #
37
37
  # This service exposes several types of comparable timestamps:
38
38
  #
39
- # * +create_time+ - The time at which a document was created. Changes only
39
+ # * `create_time` - The time at which a document was created. Changes only
40
40
  # when a document is deleted, then re-created. Increases in a strict
41
41
  # monotonic fashion.
42
- # * +update_time+ - The time at which a document was last updated. Changes
42
+ # * `update_time` - The time at which a document was last updated. Changes
43
43
  # every time a document is modified. Does not change when a write results
44
44
  # in no modifications. Increases in a strict monotonic fashion.
45
- # * +read_time+ - The time at which a particular state was observed. Used
45
+ # * `read_time` - The time at which a particular state was observed. Used
46
46
  # to denote a consistent snapshot of the database or the time at which a
47
47
  # Document was observed to not exist.
48
- # * +commit_time+ - The time at which the writes in a transaction were
49
- # committed. Any read with an equal or greater +read_time+ is guaranteed
48
+ # * `commit_time` - The time at which the writes in a transaction were
49
+ # committed. Any read with an equal or greater `read_time` is guaranteed
50
50
  # to see the effects of the transaction.
51
51
  #
52
52
  # @!attribute [r] firestore_stub
@@ -337,7 +337,7 @@ module Google
337
337
  #
338
338
  # @param name [String]
339
339
  # The resource name of the Document to get. In the format:
340
- # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
340
+ # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
341
341
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
342
342
  # The fields to return. If not set, returns all fields.
343
343
  #
@@ -388,14 +388,14 @@ module Google
388
388
  #
389
389
  # @param parent [String]
390
390
  # The parent resource name. In the format:
391
- # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
392
- # +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}`.
393
393
  # For example:
394
- # +projects/my-project/databases/my-database/documents+ or
395
- # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
394
+ # `projects/my-project/databases/my-database/documents` or
395
+ # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
396
396
  # @param collection_id [String]
397
- # The collection ID, relative to +parent+, to list. For example: +chatrooms+
398
- # or +messages+.
397
+ # The collection ID, relative to `parent`, to list. For example: `chatrooms`
398
+ # or `messages`.
399
399
  # @param page_size [Integer]
400
400
  # The maximum number of resources contained in the underlying API
401
401
  # response. If page streaming is performed per-resource, this
@@ -403,7 +403,7 @@ module Google
403
403
  # performed per-page, this determines the maximum number of
404
404
  # resources in a page.
405
405
  # @param order_by [String]
406
- # The order to sort results by. For example: +priority desc, name+.
406
+ # The order to sort results by. For example: `priority desc, name`.
407
407
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
408
408
  # The fields to return. If not set, returns all fields.
409
409
  #
@@ -424,8 +424,8 @@ module Google
424
424
  # be returned with a key but will not have fields, {Google::Firestore::V1beta1::Document#create_time Document#create_time},
425
425
  # or {Google::Firestore::V1beta1::Document#update_time Document#update_time} set.
426
426
  #
427
- # Requests with +show_missing+ may not specify +where+ or
428
- # +order_by+.
427
+ # Requests with `show_missing` may not specify `where` or
428
+ # `order_by`.
429
429
  # @param options [Google::Gax::CallOptions]
430
430
  # Overrides the default settings for this call, e.g, timeout,
431
431
  # retries, etc.
@@ -444,7 +444,7 @@ module Google
444
444
  # firestore_client = Google::Cloud::Firestore::V1beta1.new
445
445
  # formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
446
446
  #
447
- # # TODO: Initialize +collection_id+:
447
+ # # TODO: Initialize `collection_id`:
448
448
  # collection_id = ''
449
449
  #
450
450
  # # Iterate over all results.
@@ -489,16 +489,16 @@ module Google
489
489
  #
490
490
  # @param parent [String]
491
491
  # The parent resource. For example:
492
- # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
493
- # +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}`
494
494
  # @param collection_id [String]
495
- # The collection ID, relative to +parent+, to list. For example: +chatrooms+.
495
+ # The collection ID, relative to `parent`, to list. For example: `chatrooms`.
496
496
  # @param document_id [String]
497
497
  # The client-assigned document ID to use for this document.
498
498
  #
499
499
  # Optional. If not specified, an ID will be assigned by the service.
500
500
  # @param document [Google::Firestore::V1beta1::Document | Hash]
501
- # The document to create. +name+ must not be set.
501
+ # The document to create. `name` must not be set.
502
502
  # A hash of the same form as `Google::Firestore::V1beta1::Document`
503
503
  # can also be provided.
504
504
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
@@ -522,13 +522,13 @@ module Google
522
522
  # firestore_client = Google::Cloud::Firestore::V1beta1.new
523
523
  # formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
524
524
  #
525
- # # TODO: Initialize +collection_id+:
525
+ # # TODO: Initialize `collection_id`:
526
526
  # collection_id = ''
527
527
  #
528
- # # TODO: Initialize +document_id+:
528
+ # # TODO: Initialize `document_id`:
529
529
  # document_id = ''
530
530
  #
531
- # # TODO: Initialize +document+:
531
+ # # TODO: Initialize `document`:
532
532
  # document = {}
533
533
  # response = firestore_client.create_document(formatted_parent, collection_id, document_id, document)
534
534
 
@@ -593,10 +593,10 @@ module Google
593
593
  #
594
594
  # firestore_client = Google::Cloud::Firestore::V1beta1.new
595
595
  #
596
- # # TODO: Initialize +document+:
596
+ # # TODO: Initialize `document`:
597
597
  # document = {}
598
598
  #
599
- # # TODO: Initialize +update_mask+:
599
+ # # TODO: Initialize `update_mask`:
600
600
  # update_mask = {}
601
601
  # response = firestore_client.update_document(document, update_mask)
602
602
 
@@ -621,7 +621,7 @@ module Google
621
621
  #
622
622
  # @param name [String]
623
623
  # The resource name of the Document to delete. In the format:
624
- # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
624
+ # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
625
625
  # @param current_document [Google::Firestore::V1beta1::Precondition | Hash]
626
626
  # An optional precondition on the document.
627
627
  # The request will fail if this is set and not met by the target document.
@@ -662,12 +662,12 @@ module Google
662
662
  #
663
663
  # @param database [String]
664
664
  # The database name. In the format:
665
- # +projects/\\{project_id}/databases/\\{database_id}+.
665
+ # `projects/{project_id}/databases/{database_id}`.
666
666
  # @param documents [Array<String>]
667
667
  # The names of the documents to retrieve. In the format:
668
- # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
668
+ # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
669
669
  # The request will fail if any of the document is not a child resource of the
670
- # given +database+. Duplicate names will be elided.
670
+ # given `database`. Duplicate names will be elided.
671
671
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
672
672
  # The fields to return. If not set, returns all fields.
673
673
  #
@@ -702,7 +702,7 @@ module Google
702
702
  # firestore_client = Google::Cloud::Firestore::V1beta1.new
703
703
  # formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
704
704
  #
705
- # # TODO: Initialize +documents+:
705
+ # # TODO: Initialize `documents`:
706
706
  # documents = []
707
707
  # firestore_client.batch_get_documents(formatted_database, documents).each do |element|
708
708
  # # Process element.
@@ -732,7 +732,7 @@ module Google
732
732
  #
733
733
  # @param database [String]
734
734
  # The database name. In the format:
735
- # +projects/\\{project_id}/databases/\\{database_id}+.
735
+ # `projects/{project_id}/databases/{database_id}`.
736
736
  # @param options_ [Google::Firestore::V1beta1::TransactionOptions | Hash]
737
737
  # The options for the transaction.
738
738
  # Defaults to a read-write transaction.
@@ -770,7 +770,7 @@ module Google
770
770
  #
771
771
  # @param database [String]
772
772
  # The database name. In the format:
773
- # +projects/\\{project_id}/databases/\\{database_id}+.
773
+ # `projects/{project_id}/databases/{database_id}`.
774
774
  # @param writes [Array<Google::Firestore::V1beta1::Write | Hash>]
775
775
  # The writes to apply.
776
776
  #
@@ -793,7 +793,7 @@ module Google
793
793
  # firestore_client = Google::Cloud::Firestore::V1beta1.new
794
794
  # formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
795
795
  #
796
- # # TODO: Initialize +writes+:
796
+ # # TODO: Initialize `writes`:
797
797
  # writes = []
798
798
  # response = firestore_client.commit(formatted_database, writes)
799
799
 
@@ -816,7 +816,7 @@ module Google
816
816
  #
817
817
  # @param database [String]
818
818
  # The database name. In the format:
819
- # +projects/\\{project_id}/databases/\\{database_id}+.
819
+ # `projects/{project_id}/databases/{database_id}`.
820
820
  # @param transaction [String]
821
821
  # The transaction to roll back.
822
822
  # @param options [Google::Gax::CallOptions]
@@ -832,7 +832,7 @@ module Google
832
832
  # firestore_client = Google::Cloud::Firestore::V1beta1.new
833
833
  # formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
834
834
  #
835
- # # TODO: Initialize +transaction+:
835
+ # # TODO: Initialize `transaction`:
836
836
  # transaction = ''
837
837
  # firestore_client.rollback(formatted_database, transaction)
838
838
 
@@ -854,11 +854,11 @@ module Google
854
854
  #
855
855
  # @param parent [String]
856
856
  # The parent resource name. In the format:
857
- # +projects/\\{project_id}/databases/\\{database_id}/documents+ or
858
- # +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}`.
859
859
  # For example:
860
- # +projects/my-project/databases/my-database/documents+ or
861
- # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
860
+ # `projects/my-project/databases/my-database/documents` or
861
+ # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
862
862
  # @param structured_query [Google::Firestore::V1beta1::StructuredQuery | Hash]
863
863
  # A structured query.
864
864
  # A hash of the same form as `Google::Firestore::V1beta1::StructuredQuery`
@@ -985,9 +985,9 @@ module Google
985
985
  #
986
986
  # @param parent [String]
987
987
  # The parent document. In the format:
988
- # +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
988
+ # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
989
989
  # For example:
990
- # +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
990
+ # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
991
991
  # @param page_size [Integer]
992
992
  # The maximum number of resources contained in the underlying API
993
993
  # response. If page streaming is performed per-resource, this