google-cloud-firestore-v1 0.4.6 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4feb728a289d76179ce2a815cd9cda728103a36678cc02d90dfe2013ed82a77f
4
- data.tar.gz: 8b137c2fff1b0db9774086d02cd69432bad57ce6c3bcd6b4d119b1a4fa07cf96
3
+ metadata.gz: 71aac6d64371cbc93df74926ccbd1fb316289ea293b4ecc46000429562cfaf95
4
+ data.tar.gz: fef852d8d1d8d5c9d42edefd86f7fd0df4c8306bf7c0950bf835a506455bf89e
5
5
  SHA512:
6
- metadata.gz: 994499fbfb3778eb17fb88fd238796acb413337d4fbb63a43275198c5811eabb52361ae9f716876e7694634f58a88ece72aae59c1ac4b6aff857e26d524754bb
7
- data.tar.gz: e549974988be248e4fd71fd7f29bcd87b0a9489f97bd4352185b631e8a2d80d1861d5ef57c501259d70f2cba3276aeae801d0f61215a2317358a98bdbd76570f
6
+ metadata.gz: 7ca80a0c3118b395384b831ceb3c8f2b01dd4d445716a50bb07a0adf57b45a34bc03d04f38d386a9a25d4884205f5f1b1bd3bf1dda1688645333256ef13ddefe
7
+ data.tar.gz: fbdad77e2109c7990bfa8780f8d465e851c0400426ac1d7d4995d23f5828fc0f5b0a240672053744d62467f9f9b136c90d8f9b4335ea1924bb5cd02dd5ce77b8
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Firestore::V1::GetDocumentRequest.new # (request fiel
37
37
  response = client.get_document request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-firestore-v1/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-v1/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/firestore)
@@ -1044,7 +1044,9 @@ module Google
1044
1044
  # @param structured_query [::Google::Cloud::Firestore::V1::StructuredQuery, ::Hash]
1045
1045
  # A structured query.
1046
1046
  # @param transaction [::String]
1047
- # Reads documents in a transaction.
1047
+ # Run the query within an already active transaction.
1048
+ #
1049
+ # The value here is the opaque transaction ID to execute the query in.
1048
1050
  # @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
1049
1051
  # Starts a new transaction and reads the documents.
1050
1052
  # Defaults to a read-only transaction.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Firestore
23
23
  module V1
24
- VERSION = "0.4.6"
24
+ VERSION = "0.5.0"
25
25
  end
26
26
  end
27
27
  end
@@ -25,6 +25,8 @@ module Google
25
25
  ##
26
26
  # To load this package, including all its services, and instantiate a client:
27
27
  #
28
+ # @example
29
+ #
28
30
  # require "google/cloud/firestore/v1"
29
31
  # client = ::Google::Cloud::Firestore::V1::Firestore::Client.new
30
32
  #
@@ -1,10 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/v1/common.proto
3
3
 
4
- require 'google/protobuf/timestamp_pb'
5
- require 'google/api/annotations_pb'
6
4
  require 'google/protobuf'
7
5
 
6
+ require 'google/protobuf/timestamp_pb'
7
+
8
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
9
9
  add_file("google/firestore/v1/common.proto", :syntax => :proto3) do
10
10
  add_message "google.firestore.v1.DocumentMask" do
@@ -1,11 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/v1/document.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/protobuf/struct_pb'
5
7
  require 'google/protobuf/timestamp_pb'
6
8
  require 'google/type/latlng_pb'
7
- require 'google/api/annotations_pb'
8
- require 'google/protobuf'
9
9
 
10
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  add_file("google/firestore/v1/document.proto", :syntax => :proto3) do
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/v1/firestore.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
@@ -11,7 +13,6 @@ require 'google/firestore/v1/write_pb'
11
13
  require 'google/protobuf/empty_pb'
12
14
  require 'google/protobuf/timestamp_pb'
13
15
  require 'google/rpc/status_pb'
14
- require 'google/protobuf'
15
16
 
16
17
  Google::Protobuf::DescriptorPool.generated_pool.build do
17
18
  add_file("google/firestore/v1/firestore.proto", :syntax => :proto3) do
@@ -111,6 +112,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
111
112
  optional :document, :message, 1, "google.firestore.v1.Document"
112
113
  optional :read_time, :message, 3, "google.protobuf.Timestamp"
113
114
  optional :skipped_results, :int32, 4
115
+ oneof :continuation_selector do
116
+ optional :done, :bool, 6
117
+ end
114
118
  end
115
119
  add_message "google.firestore.v1.PartitionQueryRequest" do
116
120
  optional :parent, :string, 1
@@ -1,10 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/v1/query.proto
3
3
 
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
4
7
  require 'google/firestore/v1/document_pb'
5
8
  require 'google/protobuf/wrappers_pb'
6
- require 'google/api/annotations_pb'
7
- require 'google/protobuf'
8
9
 
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
11
  add_file("google/firestore/v1/query.proto", :syntax => :proto3) do
@@ -1,11 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/v1/write.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/firestore/v1/common_pb'
5
7
  require 'google/firestore/v1/document_pb'
6
8
  require 'google/protobuf/timestamp_pb'
7
- require 'google/api/annotations_pb'
8
- require 'google/protobuf'
9
9
 
10
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  add_file("google/firestore/v1/write.proto", :syntax => :proto3) do
@@ -43,7 +43,7 @@ module Google
43
43
  # @!attribute [rw] update_time
44
44
  # @return [::Google::Protobuf::Timestamp]
45
45
  # When set, the target document must exist and have been last updated at
46
- # that time.
46
+ # that time. Timestamp must be microsecond aligned.
47
47
  class Precondition
48
48
  include ::Google::Protobuf::MessageExts
49
49
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -319,7 +319,9 @@ module Google
319
319
  # A structured query.
320
320
  # @!attribute [rw] transaction
321
321
  # @return [::String]
322
- # Reads documents in a transaction.
322
+ # Run the query within an already active transaction.
323
+ #
324
+ # The value here is the opaque transaction ID to execute the query in.
323
325
  # @!attribute [rw] new_transaction
324
326
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions]
325
327
  # Starts a new transaction and reads the documents.
@@ -344,8 +346,7 @@ module Google
344
346
  # If set, no other fields will be set in this response.
345
347
  # @!attribute [rw] document
346
348
  # @return [::Google::Cloud::Firestore::V1::Document]
347
- # A query result.
348
- # Not set when reporting partial progress.
349
+ # A query result, not set when reporting partial progress.
349
350
  # @!attribute [rw] read_time
350
351
  # @return [::Google::Protobuf::Timestamp]
351
352
  # The time at which the document was read. This may be monotonically
@@ -359,6 +360,10 @@ module Google
359
360
  # @return [::Integer]
360
361
  # The number of results that have been skipped due to an offset between
361
362
  # the last response and the current response.
363
+ # @!attribute [rw] done
364
+ # @return [::Boolean]
365
+ # If present, Firestore has completely finished the request and no more
366
+ # documents will be returned.
362
367
  class RunQueryResponse
363
368
  include ::Google::Protobuf::MessageExts
364
369
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -110,7 +110,10 @@ module Google
110
110
  # @!attribute [rw] filters
111
111
  # @return [::Array<::Google::Cloud::Firestore::V1::StructuredQuery::Filter>]
112
112
  # The list of filters to combine.
113
- # Must contain at least one filter.
113
+ #
114
+ # Requires:
115
+ #
116
+ # * At least one filter is present.
114
117
  class CompositeFilter
115
118
  include ::Google::Protobuf::MessageExts
116
119
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -120,7 +123,7 @@ module Google
120
123
  # Unspecified. This value must not be used.
121
124
  OPERATOR_UNSPECIFIED = 0
122
125
 
123
- # The results are required to satisfy each of the combined filters.
126
+ # Documents are required to satisfy all of the combined filters.
124
127
  AND = 1
125
128
  end
126
129
  end
@@ -44,7 +44,7 @@ module Google
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
46
  #
47
- # Example 3: Pack and unpack a message in Python.
47
+ # Example 3: Pack and unpack a message in Python.
48
48
  #
49
49
  # foo = Foo(...)
50
50
  # any = Any()
@@ -54,7 +54,7 @@ module Google
54
54
  # any.Unpack(foo)
55
55
  # ...
56
56
  #
57
- # Example 4: Pack and unpack a message in Go
57
+ # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
60
  # any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
75
75
  #
76
76
  #
77
77
  # JSON
78
- # ====
78
+ #
79
79
  # The JSON representation of an `Any` value uses the regular
80
80
  # representation of the deserialized, embedded message, with an
81
81
  # additional field `@type` which contains the type URL. Example:
@@ -46,8 +46,8 @@ module Google
46
46
 
47
47
  # `Value` represents a dynamically typed value which can be either
48
48
  # null, a number, a string, a boolean, a recursive struct value, or a
49
- # list of values. A producer of value is expected to set one of that
50
- # variants, absence of any variant indicates an error.
49
+ # list of values. A producer of value is expected to set one of these
50
+ # variants. Absence of any variant indicates an error.
51
51
  #
52
52
  # The JSON representation for `Value` is JSON value.
53
53
  # @!attribute [rw] null_value
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.6
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-11 00:00:00.000000000 Z
11
+ date: 2022-04-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
215
215
  - !ruby/object:Gem::Version
216
216
  version: '0'
217
217
  requirements: []
218
- rubygems_version: 3.3.4
218
+ rubygems_version: 3.3.5
219
219
  signing_key:
220
220
  specification_version: 4
221
221
  summary: API Client library for the Cloud Firestore V1 API