google-cloud-firestore-v1 0.2.2 → 0.4.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4ebf40d668a9641ffff046faf42b210e06953c3a2f15951edde70b1869a79f60
4
- data.tar.gz: e76cadfae696483c66ed75bc1f2cdc8fc8a19e5a179032c55d8f7ff48a9198aa
3
+ metadata.gz: b142502a0188e2e275037266c5f59f45d08bb08025229b49ec1672b1564c5c35
4
+ data.tar.gz: 6f0ba25683a831e0c14dc6fd493eb24c86f918004446e198e4ce292658147f9d
5
5
  SHA512:
6
- metadata.gz: c5a51239b0929bbd14b3fe30c4805cab42864b937c95cf5c535fc18f6b652ccf1a89b0b0920a63ccf845081cf4cd198577cd2ccb4f14970dfb950c4857f29bba
7
- data.tar.gz: 7942537e54702bc27f2e9a13c1aee3fe3f5f4af86d3ddd54536f66d06b5b8fa3c6b71f3c601fd118cb00fc8b7a6f7fbf8c24b9a8d5e8236626cf982f485b64d2
6
+ metadata.gz: da3862cad7a0f1a855ff3fb925790e73b8763bd5d4356073ff7c263438f1f2fe71216c24b13cef119fe417b0966bcb72acfa44f51f1cb8d6b1d93610001d5f75
7
+ data.tar.gz: fcec5926bfdbea2a53dafbb67c5d56b5a495f8614f249bb43619b3b840e562ac2e3e1c2a7baacbf73fd17c09f14d54eef46fb279aa42efeda0d1e833086374e2
data/LICENSE.md CHANGED
@@ -1,192 +1,190 @@
1
- Apache License
2
- ==============
3
-
4
- * Version 2.0, January 2004
5
- * https://www.apache.org/licenses/
6
-
7
- ### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
-
9
- 1. **Definitions.**
10
-
11
- "License" shall mean the terms and conditions for use, reproduction,
12
- and distribution as defined by Sections 1 through 9 of this document.
13
-
14
- "Licensor" shall mean the copyright owner or entity authorized by
15
- the copyright owner that is granting the License.
16
-
17
- "Legal Entity" shall mean the union of the acting entity and all
18
- other entities that control, are controlled by, or are under common
19
- control with that entity. For the purposes of this definition,
20
- "control" means (i) the power, direct or indirect, to cause the
21
- direction or management of such entity, whether by contract or
22
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
- outstanding shares, or (iii) beneficial ownership of such entity.
24
-
25
- "You" (or "Your") shall mean an individual or Legal Entity
26
- exercising permissions granted by this License.
27
-
28
- "Source" form shall mean the preferred form for making modifications,
29
- including but not limited to software source code, documentation
30
- source, and configuration files.
31
-
32
- "Object" form shall mean any form resulting from mechanical
33
- transformation or translation of a Source form, including but
34
- not limited to compiled object code, generated documentation,
35
- and conversions to other media types.
36
-
37
- "Work" shall mean the work of authorship, whether in Source or
38
- Object form, made available under the License, as indicated by a
39
- copyright notice that is included in or attached to the work
40
- (an example is provided in the Appendix below).
41
-
42
- "Derivative Works" shall mean any work, whether in Source or Object
43
- form, that is based on (or derived from) the Work and for which the
44
- editorial revisions, annotations, elaborations, or other modifications
45
- represent, as a whole, an original work of authorship. For the purposes
46
- of this License, Derivative Works shall not include works that remain
47
- separable from, or merely link (or bind by name) to the interfaces of,
48
- the Work and Derivative Works thereof.
49
-
50
- "Contribution" shall mean any work of authorship, including
51
- the original version of the Work and any modifications or additions
52
- to that Work or Derivative Works thereof, that is intentionally
53
- submitted to Licensor for inclusion in the Work by the copyright owner
54
- or by an individual or Legal Entity authorized to submit on behalf of
55
- the copyright owner. For the purposes of this definition, "submitted"
56
- means any form of electronic, verbal, or written communication sent
57
- to the Licensor or its representatives, including but not limited to
58
- communication on electronic mailing lists, source code control systems,
59
- and issue tracking systems that are managed by, or on behalf of, the
60
- Licensor for the purpose of discussing and improving the Work, but
61
- excluding communication that is conspicuously marked or otherwise
62
- designated in writing by the copyright owner as "Not a Contribution."
63
-
64
- "Contributor" shall mean Licensor and any individual or Legal Entity
65
- on behalf of whom a Contribution has been received by Licensor and
66
- subsequently incorporated within the Work.
67
-
68
- 2. **Grant of Copyright License.** Subject to the terms and conditions of
69
- this License, each Contributor hereby grants to You a perpetual,
70
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
- copyright license to reproduce, prepare Derivative Works of,
72
- publicly display, publicly perform, sublicense, and distribute the
73
- Work and such Derivative Works in Source or Object form.
74
-
75
- 3. **Grant of Patent License.** Subject to the terms and conditions of
76
- this License, each Contributor hereby grants to You a perpetual,
77
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
- (except as stated in this section) patent license to make, have made,
79
- use, offer to sell, sell, import, and otherwise transfer the Work,
80
- where such license applies only to those patent claims licensable
81
- by such Contributor that are necessarily infringed by their
82
- Contribution(s) alone or by combination of their Contribution(s)
83
- with the Work to which such Contribution(s) was submitted. If You
84
- institute patent litigation against any entity (including a
85
- cross-claim or counterclaim in a lawsuit) alleging that the Work
86
- or a Contribution incorporated within the Work constitutes direct
87
- or contributory patent infringement, then any patent licenses
88
- granted to You under this License for that Work shall terminate
89
- as of the date such litigation is filed.
90
-
91
- 4. **Redistribution.** You may reproduce and distribute copies of the
92
- Work or Derivative Works thereof in any medium, with or without
93
- modifications, and in Source or Object form, provided that You
94
- meet the following conditions:
95
-
96
- * **(a)** You must give any other recipients of the Work or
97
- Derivative Works a copy of this License; and
98
-
99
- * **(b)** You must cause any modified files to carry prominent notices
100
- stating that You changed the files; and
101
-
102
- * **(c)** You must retain, in the Source form of any Derivative Works
103
- that You distribute, all copyright, patent, trademark, and
104
- attribution notices from the Source form of the Work,
105
- excluding those notices that do not pertain to any part of
106
- the Derivative Works; and
107
-
108
- * **(d)** If the Work includes a "NOTICE" text file as part of its
109
- distribution, then any Derivative Works that You distribute must
110
- include a readable copy of the attribution notices contained
111
- within such NOTICE file, excluding those notices that do not
112
- pertain to any part of the Derivative Works, in at least one
113
- of the following places: within a NOTICE text file distributed
114
- as part of the Derivative Works; within the Source form or
115
- documentation, if provided along with the Derivative Works; or,
116
- within a display generated by the Derivative Works, if and
117
- wherever such third-party notices normally appear. The contents
118
- of the NOTICE file are for informational purposes only and
119
- do not modify the License. You may add Your own attribution
120
- notices within Derivative Works that You distribute, alongside
121
- or as an addendum to the NOTICE text from the Work, provided
122
- that such additional attribution notices cannot be construed
123
- as modifying the License.
124
-
125
- You may add Your own copyright statement to Your modifications and
126
- may provide additional or different license terms and conditions
127
- for use, reproduction, or distribution of Your modifications, or
128
- for any such Derivative Works as a whole, provided Your use,
129
- reproduction, and distribution of the Work otherwise complies with
130
- the conditions stated in this License.
131
-
132
- 5. **Submission of Contributions.** Unless You explicitly state otherwise,
133
- any Contribution intentionally submitted for inclusion in the Work
134
- by You to the Licensor shall be under the terms and conditions of
135
- this License, without any additional terms or conditions.
136
- Notwithstanding the above, nothing herein shall supersede or modify
137
- the terms of any separate license agreement you may have executed
138
- with Licensor regarding such Contributions.
139
-
140
- 6. **Trademarks.** This License does not grant permission to use the trade
141
- names, trademarks, service marks, or product names of the Licensor,
142
- except as required for reasonable and customary use in describing the
143
- origin of the Work and reproducing the content of the NOTICE file.
144
-
145
- 7. **Disclaimer of Warranty.** Unless required by applicable law or
146
- agreed to in writing, Licensor provides the Work (and each
147
- Contributor provides its Contributions) on an "AS IS" BASIS,
148
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
- implied, including, without limitation, any warranties or conditions
150
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
- PARTICULAR PURPOSE. You are solely responsible for determining the
152
- appropriateness of using or redistributing the Work and assume any
153
- risks associated with Your exercise of permissions under this License.
154
-
155
- 8. **Limitation of Liability.** In no event and under no legal theory,
156
- whether in tort (including negligence), contract, or otherwise,
157
- unless required by applicable law (such as deliberate and grossly
158
- negligent acts) or agreed to in writing, shall any Contributor be
159
- liable to You for damages, including any direct, indirect, special,
160
- incidental, or consequential damages of any character arising as a
161
- result of this License or out of the use or inability to use the
162
- Work (including but not limited to damages for loss of goodwill,
163
- work stoppage, computer failure or malfunction, or any and all
164
- other commercial damages or losses), even if such Contributor
165
- has been advised of the possibility of such damages.
166
-
167
- 9. **Accepting Warranty or Additional Liability.** While redistributing
168
- the Work or Derivative Works thereof, You may choose to offer,
169
- and charge a fee for, acceptance of support, warranty, indemnity,
170
- or other liability obligations and/or rights consistent with this
171
- License. However, in accepting such obligations, You may act only
172
- on Your own behalf and on Your sole responsibility, not on behalf
173
- of any other Contributor, and only if You agree to indemnify,
174
- defend, and hold each Contributor harmless for any liability
175
- incurred by, or claims asserted against, such Contributor by reason
176
- of your accepting any such warranty or additional liability.
177
-
178
- _END OF TERMS AND CONDITIONS_
179
-
180
- ### APPENDIX: How to apply the Apache License to your work.
181
-
182
- To apply the Apache License to your work, attach the following
183
- boilerplate notice, with the fields enclosed by brackets "`[]`"
184
- replaced with your own identifying information. (Don't include
185
- the brackets!) The text should be enclosed in the appropriate
186
- comment syntax for the file format. We also recommend that a
187
- file or class name and description of purpose be included on the
188
- same "printed page" as the copyright notice for easier
189
- identification within third-party archives.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
190
188
 
191
189
  Copyright [yyyy] [name of copyright owner]
192
190
 
@@ -194,7 +192,7 @@ identification within third-party archives.
194
192
  you may not use this file except in compliance with the License.
195
193
  You may obtain a copy of the License at
196
194
 
197
- https://www.apache.org/licenses/LICENSE-2.0
195
+ http://www.apache.org/licenses/LICENSE-2.0
198
196
 
199
197
  Unless required by applicable law or agreed to in writing, software
200
198
  distributed under the License is distributed on an "AS IS" BASIS,
data/README.md CHANGED
@@ -6,6 +6,12 @@ Cloud Firestore is a NoSQL document database built for automatic scaling, high p
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Cloud Firestore V1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-firestore](https://rubygems.org/gems/google-cloud-firestore).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -65,11 +71,69 @@ end
65
71
 
66
72
  ## Supported Ruby Versions
67
73
 
68
- This library is supported on Ruby 2.4+.
74
+ This library is supported on Ruby 2.5+.
69
75
 
70
76
  Google provides official support for Ruby versions that are actively supported
71
77
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
72
- in security maintenance, and not end of life. Currently, this means Ruby 2.4
78
+ in security maintenance, and not end of life. Currently, this means Ruby 2.5
73
79
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
74
80
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
75
81
  about the Ruby support schedule.
82
+
83
+ ## Which client should I use?
84
+
85
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
+ client library with a name such as `google-cloud-firestore`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-firestore-v1`.
89
+ _In most cases, you should install the main client._
90
+
91
+ ### What's the difference between the main client and a versioned client?
92
+
93
+ A _versioned client_ provides a basic set of data types and client classes for
94
+ a _single version_ of a specific service. (That is, for a service with multiple
95
+ versions, there might be a separate versioned client for each service version.)
96
+ Most versioned clients are written and maintained by a code generator.
97
+
98
+ The _main client_ is designed to provide you with the _recommended_ client
99
+ interfaces for the service. There will be only one main client for any given
100
+ service, even a service with multiple versions. The main client includes
101
+ factory methods for constructing the client objects we recommend for most
102
+ users. In some cases, those will be classes provided by an underlying versioned
103
+ client; in other cases, they will be handwritten higher-level client objects
104
+ with additional capabilities, convenience methods, or best practices built in.
105
+ Generally, the main client will default to a recommended service version,
106
+ although in some cases you can override this if you need to talk to a specific
107
+ service version.
108
+
109
+ ### Why would I want to use the main client?
110
+
111
+ We recommend that most users install the main client gem for a service. You can
112
+ identify this gem as the one _without_ a version in its name, e.g.
113
+ `google-cloud-firestore`.
114
+ The main client is recommended because it will embody the best practices for
115
+ accessing the service, and may also provide more convenient interfaces or
116
+ tighter integration into frameworks and third-party libraries. In addition, the
117
+ documentation and samples published by Google will generally demonstrate use of
118
+ the main client.
119
+
120
+ ### Why would I want to use a versioned client?
121
+
122
+ You can use a versioned client if you are content with a possibly lower-level
123
+ class interface, you explicitly want to avoid features provided by the main
124
+ client, or you want to access a specific service version not be covered by the
125
+ main client. You can identify versioned client gems because the service version
126
+ is part of the name, e.g. `google-cloud-firestore-v1`.
127
+
128
+ ### What about the google-apis-<name> clients?
129
+
130
+ Client library gems with names that begin with `google-apis-` are based on an
131
+ older code generation technology. They talk to a REST/JSON backend (whereas
132
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
133
+ not offer the same performance, features, and ease of use provided by more
134
+ modern clients.
135
+
136
+ The `google-apis-` clients have wide coverage across Google services, so you
137
+ might need to use one if there is no modern client available for the service.
138
+ However, if a modern client is available, we generally recommend it over the
139
+ older `google-apis-` clients.
@@ -33,3 +33,6 @@ module Google
33
33
  end
34
34
  end
35
35
  end
36
+
37
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
38
+ require "google/cloud/firestore/v1/_helpers" if ::File.file? helper_path
@@ -65,7 +65,7 @@ module Google
65
65
  parent_config = while namespace.any?
66
66
  parent_name = namespace.join "::"
67
67
  parent_const = const_get parent_name
68
- break parent_const.configure if parent_const&.respond_to? :configure
68
+ break parent_const.configure if parent_const.respond_to? :configure
69
69
  namespace.pop
70
70
  end
71
71
  default_config = Client::Configuration.new parent_config
@@ -73,81 +73,81 @@ module Google
73
73
  default_config.rpcs.get_document.timeout = 60.0
74
74
  default_config.rpcs.get_document.retry_policy = {
75
75
  initial_delay: 0.1,
76
- max_delay: 60.0,
77
- multiplier: 1.3,
78
- retry_codes: [14, 13, 4]
76
+ max_delay: 60.0,
77
+ multiplier: 1.3,
78
+ retry_codes: [8, 14, 13, 4]
79
79
  }
80
80
 
81
81
  default_config.rpcs.list_documents.timeout = 60.0
82
82
  default_config.rpcs.list_documents.retry_policy = {
83
83
  initial_delay: 0.1,
84
- max_delay: 60.0,
85
- multiplier: 1.3,
86
- retry_codes: [14, 13, 4]
84
+ max_delay: 60.0,
85
+ multiplier: 1.3,
86
+ retry_codes: [8, 14, 13, 4]
87
87
  }
88
88
 
89
89
  default_config.rpcs.update_document.timeout = 60.0
90
90
  default_config.rpcs.update_document.retry_policy = {
91
91
  initial_delay: 0.1,
92
- max_delay: 60.0,
93
- multiplier: 1.3,
94
- retry_codes: [14]
92
+ max_delay: 60.0,
93
+ multiplier: 1.3,
94
+ retry_codes: [8, 14]
95
95
  }
96
96
 
97
97
  default_config.rpcs.delete_document.timeout = 60.0
98
98
  default_config.rpcs.delete_document.retry_policy = {
99
99
  initial_delay: 0.1,
100
- max_delay: 60.0,
101
- multiplier: 1.3,
102
- retry_codes: [14, 13, 4]
100
+ max_delay: 60.0,
101
+ multiplier: 1.3,
102
+ retry_codes: [8, 14, 13, 4]
103
103
  }
104
104
 
105
105
  default_config.rpcs.batch_get_documents.timeout = 300.0
106
106
  default_config.rpcs.batch_get_documents.retry_policy = {
107
107
  initial_delay: 0.1,
108
- max_delay: 60.0,
109
- multiplier: 1.3,
110
- retry_codes: [14, 13, 4]
108
+ max_delay: 60.0,
109
+ multiplier: 1.3,
110
+ retry_codes: [8, 14, 13, 4]
111
111
  }
112
112
 
113
113
  default_config.rpcs.begin_transaction.timeout = 60.0
114
114
  default_config.rpcs.begin_transaction.retry_policy = {
115
115
  initial_delay: 0.1,
116
- max_delay: 60.0,
117
- multiplier: 1.3,
118
- retry_codes: [14, 13, 4]
116
+ max_delay: 60.0,
117
+ multiplier: 1.3,
118
+ retry_codes: [8, 14, 13, 4]
119
119
  }
120
120
 
121
121
  default_config.rpcs.commit.timeout = 60.0
122
122
  default_config.rpcs.commit.retry_policy = {
123
123
  initial_delay: 0.1,
124
- max_delay: 60.0,
125
- multiplier: 1.3,
126
- retry_codes: [14]
124
+ max_delay: 60.0,
125
+ multiplier: 1.3,
126
+ retry_codes: [8, 14]
127
127
  }
128
128
 
129
129
  default_config.rpcs.rollback.timeout = 60.0
130
130
  default_config.rpcs.rollback.retry_policy = {
131
131
  initial_delay: 0.1,
132
- max_delay: 60.0,
133
- multiplier: 1.3,
134
- retry_codes: [14, 13, 4]
132
+ max_delay: 60.0,
133
+ multiplier: 1.3,
134
+ retry_codes: [8, 14, 13, 4]
135
135
  }
136
136
 
137
137
  default_config.rpcs.run_query.timeout = 300.0
138
138
  default_config.rpcs.run_query.retry_policy = {
139
139
  initial_delay: 0.1,
140
- max_delay: 60.0,
141
- multiplier: 1.3,
142
- retry_codes: [14, 13, 4]
140
+ max_delay: 60.0,
141
+ multiplier: 1.3,
142
+ retry_codes: [8, 14, 13, 4]
143
143
  }
144
144
 
145
145
  default_config.rpcs.partition_query.timeout = 300.0
146
146
  default_config.rpcs.partition_query.retry_policy = {
147
147
  initial_delay: 0.1,
148
- max_delay: 60.0,
149
- multiplier: 1.3,
150
- retry_codes: [14, 13, 4]
148
+ max_delay: 60.0,
149
+ multiplier: 1.3,
150
+ retry_codes: [8, 14, 13, 4]
151
151
  }
152
152
 
153
153
  default_config.rpcs.write.timeout = 86_400.0
@@ -155,33 +155,33 @@ module Google
155
155
  default_config.rpcs.listen.timeout = 86_400.0
156
156
  default_config.rpcs.listen.retry_policy = {
157
157
  initial_delay: 0.1,
158
- max_delay: 60.0,
159
- multiplier: 1.3,
160
- retry_codes: [14, 13, 4]
158
+ max_delay: 60.0,
159
+ multiplier: 1.3,
160
+ retry_codes: [8, 14, 13, 4]
161
161
  }
162
162
 
163
163
  default_config.rpcs.list_collection_ids.timeout = 60.0
164
164
  default_config.rpcs.list_collection_ids.retry_policy = {
165
165
  initial_delay: 0.1,
166
- max_delay: 60.0,
167
- multiplier: 1.3,
168
- retry_codes: [14, 13, 4]
166
+ max_delay: 60.0,
167
+ multiplier: 1.3,
168
+ retry_codes: [8, 14, 13, 4]
169
169
  }
170
170
 
171
171
  default_config.rpcs.batch_write.timeout = 60.0
172
172
  default_config.rpcs.batch_write.retry_policy = {
173
173
  initial_delay: 0.1,
174
- max_delay: 60.0,
175
- multiplier: 1.3,
176
- retry_codes: [14, 10]
174
+ max_delay: 60.0,
175
+ multiplier: 1.3,
176
+ retry_codes: [8, 14, 10]
177
177
  }
178
178
 
179
179
  default_config.rpcs.create_document.timeout = 60.0
180
180
  default_config.rpcs.create_document.retry_policy = {
181
181
  initial_delay: 0.1,
182
- max_delay: 60.0,
183
- multiplier: 1.3,
184
- retry_codes: [14]
182
+ max_delay: 60.0,
183
+ multiplier: 1.3,
184
+ retry_codes: [8, 14]
185
185
  }
186
186
 
187
187
  default_config
@@ -245,7 +245,13 @@ module Google
245
245
 
246
246
  # Create credentials
247
247
  credentials = @config.credentials
248
- credentials ||= Credentials.default scope: @config.scope
248
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
249
+ # but only if the default endpoint does not have a region prefix.
250
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
251
+ @config.endpoint == Client.configure.endpoint &&
252
+ !@config.endpoint.split(".").first.include?("-")
253
+ credentials ||= Credentials.default scope: @config.scope,
254
+ enable_self_signed_jwt: enable_self_signed_jwt
249
255
  if credentials.is_a?(String) || credentials.is_a?(Hash)
250
256
  credentials = Credentials.new credentials, scope: @config.scope
251
257
  end
@@ -419,7 +425,7 @@ module Google
419
425
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
420
426
 
421
427
  header_params = {
422
- "parent" => request.parent,
428
+ "parent" => request.parent,
423
429
  "collection_id" => request.collection_id
424
430
  }
425
431
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
@@ -1409,7 +1415,7 @@ module Google
1409
1415
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1410
1416
 
1411
1417
  header_params = {
1412
- "parent" => request.parent,
1418
+ "parent" => request.parent,
1413
1419
  "collection_id" => request.collection_id
1414
1420
  }
1415
1421
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
@@ -1521,7 +1527,7 @@ module Google
1521
1527
  config_attr :scope, nil, ::String, ::Array, nil
1522
1528
  config_attr :lib_name, nil, ::String, nil
1523
1529
  config_attr :lib_version, nil, ::String, nil
1524
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
1530
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
1525
1531
  config_attr :interceptors, nil, ::Array, nil
1526
1532
  config_attr :timeout, nil, ::Numeric, nil
1527
1533
  config_attr :metadata, nil, ::Hash, nil
@@ -1542,7 +1548,7 @@ module Google
1542
1548
  def rpcs
1543
1549
  @rpcs ||= begin
1544
1550
  parent_rpcs = nil
1545
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
1551
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
1546
1552
  Rpcs.new parent_rpcs
1547
1553
  end
1548
1554
  end
@@ -1554,7 +1560,7 @@ module Google
1554
1560
  # Each configuration object is of type `Gapic::Config::Method` and includes
1555
1561
  # the following configuration fields:
1556
1562
  #
1557
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
1563
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1558
1564
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
1559
1565
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1560
1566
  # include the following keys:
@@ -1643,35 +1649,35 @@ module Google
1643
1649
 
1644
1650
  # @private
1645
1651
  def initialize parent_rpcs = nil
1646
- get_document_config = parent_rpcs&.get_document if parent_rpcs&.respond_to? :get_document
1652
+ get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
1647
1653
  @get_document = ::Gapic::Config::Method.new get_document_config
1648
- list_documents_config = parent_rpcs&.list_documents if parent_rpcs&.respond_to? :list_documents
1654
+ list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
1649
1655
  @list_documents = ::Gapic::Config::Method.new list_documents_config
1650
- update_document_config = parent_rpcs&.update_document if parent_rpcs&.respond_to? :update_document
1656
+ update_document_config = parent_rpcs.update_document if parent_rpcs.respond_to? :update_document
1651
1657
  @update_document = ::Gapic::Config::Method.new update_document_config
1652
- delete_document_config = parent_rpcs&.delete_document if parent_rpcs&.respond_to? :delete_document
1658
+ delete_document_config = parent_rpcs.delete_document if parent_rpcs.respond_to? :delete_document
1653
1659
  @delete_document = ::Gapic::Config::Method.new delete_document_config
1654
- batch_get_documents_config = parent_rpcs&.batch_get_documents if parent_rpcs&.respond_to? :batch_get_documents
1660
+ batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
1655
1661
  @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
1656
- begin_transaction_config = parent_rpcs&.begin_transaction if parent_rpcs&.respond_to? :begin_transaction
1662
+ begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
1657
1663
  @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
1658
- commit_config = parent_rpcs&.commit if parent_rpcs&.respond_to? :commit
1664
+ commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit
1659
1665
  @commit = ::Gapic::Config::Method.new commit_config
1660
- rollback_config = parent_rpcs&.rollback if parent_rpcs&.respond_to? :rollback
1666
+ rollback_config = parent_rpcs.rollback if parent_rpcs.respond_to? :rollback
1661
1667
  @rollback = ::Gapic::Config::Method.new rollback_config
1662
- run_query_config = parent_rpcs&.run_query if parent_rpcs&.respond_to? :run_query
1668
+ run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
1663
1669
  @run_query = ::Gapic::Config::Method.new run_query_config
1664
- partition_query_config = parent_rpcs&.partition_query if parent_rpcs&.respond_to? :partition_query
1670
+ partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query
1665
1671
  @partition_query = ::Gapic::Config::Method.new partition_query_config
1666
- write_config = parent_rpcs&.write if parent_rpcs&.respond_to? :write
1672
+ write_config = parent_rpcs.write if parent_rpcs.respond_to? :write
1667
1673
  @write = ::Gapic::Config::Method.new write_config
1668
- listen_config = parent_rpcs&.listen if parent_rpcs&.respond_to? :listen
1674
+ listen_config = parent_rpcs.listen if parent_rpcs.respond_to? :listen
1669
1675
  @listen = ::Gapic::Config::Method.new listen_config
1670
- list_collection_ids_config = parent_rpcs&.list_collection_ids if parent_rpcs&.respond_to? :list_collection_ids
1676
+ list_collection_ids_config = parent_rpcs.list_collection_ids if parent_rpcs.respond_to? :list_collection_ids
1671
1677
  @list_collection_ids = ::Gapic::Config::Method.new list_collection_ids_config
1672
- batch_write_config = parent_rpcs&.batch_write if parent_rpcs&.respond_to? :batch_write
1678
+ batch_write_config = parent_rpcs.batch_write if parent_rpcs.respond_to? :batch_write
1673
1679
  @batch_write = ::Gapic::Config::Method.new batch_write_config
1674
- create_document_config = parent_rpcs&.create_document if parent_rpcs&.respond_to? :create_document
1680
+ create_document_config = parent_rpcs.create_document if parent_rpcs.respond_to? :create_document
1675
1681
  @create_document = ::Gapic::Config::Method.new create_document_config
1676
1682
 
1677
1683
  yield self if block_given?
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Firestore
23
23
  module V1
24
- VERSION = "0.2.2"
24
+ VERSION = "0.4.2"
25
25
  end
26
26
  end
27
27
  end
@@ -36,7 +36,7 @@ module Google
36
36
  # building truly serverless apps.
37
37
  class Service
38
38
 
39
- include GRPC::GenericService
39
+ include ::GRPC::GenericService
40
40
 
41
41
  self.marshal_class_method = :encode
42
42
  self.unmarshal_class_method = :decode
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -158,7 +158,8 @@ module Google
158
158
  SERVER_VALUE_UNSPECIFIED = 0
159
159
 
160
160
  # The time at which the server processed the request, with millisecond
161
- # precision.
161
+ # precision. If used on multiple fields (same or different documents) in
162
+ # a transaction, all the fields will get the same server timestamp.
162
163
  REQUEST_TIME = 1
163
164
  end
164
165
  end
@@ -57,10 +57,13 @@ module Google
57
57
  # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
- # any, err := ptypes.MarshalAny(foo)
60
+ # any, err := anypb.New(foo)
61
+ # if err != nil {
62
+ # ...
63
+ # }
61
64
  # ...
62
65
  # foo := &pb.Foo{}
63
- # if err := ptypes.UnmarshalAny(any, foo); err != nil {
66
+ # if err := any.UnmarshalTo(foo); err != nil {
64
67
  # ...
65
68
  # }
66
69
  #
@@ -70,7 +70,16 @@ module Google
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
72
  #
73
- # Example 5: Compute Timestamp from current time in Python.
73
+ # Example 5: Compute Timestamp from Java `Instant.now()`.
74
+ #
75
+ # Instant now = Instant.now();
76
+ #
77
+ # Timestamp timestamp =
78
+ # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
+ # .setNanos(now.getNano()).build();
80
+ #
81
+ #
82
+ # Example 6: Compute Timestamp from current time in Python.
74
83
  #
75
84
  # timestamp = Timestamp()
76
85
  # timestamp.GetCurrentTime()
@@ -19,8 +19,8 @@
19
19
 
20
20
  module Google
21
21
  module Type
22
- # An object representing a latitude/longitude pair. This is expressed as a pair
23
- # of doubles representing degrees latitude and degrees longitude. Unless
22
+ # An object that represents a latitude/longitude pair. This is expressed as a
23
+ # pair of doubles to represent degrees latitude and degrees longitude. Unless
24
24
  # specified otherwise, this must conform to the
25
25
  # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
26
26
  # standard</a>. Values must be within normalized ranges.
metadata CHANGED
@@ -1,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.4.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-10-26 00:00:00.000000000 Z
11
+ date: 2021-06-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.5'
20
+ - - "<"
18
21
  - !ruby/object:Gem::Version
19
- version: '0.3'
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.5'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.3'
32
+ version: 2.a
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: google-cloud-errors
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
44
50
  requirements:
45
51
  - - "~>"
46
52
  - !ruby/object:Gem::Version
47
- version: 1.24.0
53
+ version: 1.25.1
48
54
  type: :development
49
55
  prerelease: false
50
56
  version_requirements: !ruby/object:Gem::Requirement
51
57
  requirements:
52
58
  - - "~>"
53
59
  - !ruby/object:Gem::Version
54
- version: 1.24.0
60
+ version: 1.25.1
55
61
  - !ruby/object:Gem::Dependency
56
62
  name: minitest
57
63
  requirement: !ruby/object:Gem::Requirement
@@ -151,7 +157,9 @@ dependencies:
151
157
  - !ruby/object:Gem::Version
152
158
  version: '0.9'
153
159
  description: Cloud Firestore is a NoSQL document database built for automatic scaling,
154
- high performance, and ease of application development.
160
+ high performance, and ease of application development. Note that google-cloud-firestore-v1
161
+ is a version-specific client library. For most uses, we recommend installing the
162
+ main client library google-cloud-firestore instead. See the readme for more details.
155
163
  email: googleapis-packages@google.com
156
164
  executables: []
157
165
  extensions: []
@@ -200,14 +208,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
200
208
  requirements:
201
209
  - - ">="
202
210
  - !ruby/object:Gem::Version
203
- version: '2.4'
211
+ version: '2.5'
204
212
  required_rubygems_version: !ruby/object:Gem::Requirement
205
213
  requirements:
206
214
  - - ">="
207
215
  - !ruby/object:Gem::Version
208
216
  version: '0'
209
217
  requirements: []
210
- rubygems_version: 3.1.4
218
+ rubygems_version: 3.2.17
211
219
  signing_key:
212
220
  specification_version: 4
213
221
  summary: API Client library for the Cloud Firestore V1 API