google-cloud-firestore-v1 0.4.7 → 0.6.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: 293b70f0f7cc7c6e008c6994dde6ba5f8063d7a33e2a5b28c725c0c00025e507
4
- data.tar.gz: 871fde3478084cdaa5997777e872d74ea666f383c0edb1c4355affba0510f480
3
+ metadata.gz: bd8c5117167e630dbb3e396da647c0aef398fd168f3aa7fa7b4d4e0bf0b37406
4
+ data.tar.gz: 42a8a4c062a1c3325e421ab2b8376ca987193f8ccba3ec96dee8e530a2a3abbb
5
5
  SHA512:
6
- metadata.gz: 8c47a82db34970f65434c9ce02edfcccca5d95cc4df0d045fb9c6c86cb0eafa1e9554171d2f896905fa73cee22a8fc80446895e344e934bfb1109bac8d8d6384
7
- data.tar.gz: 7f73d907f39f970adee76595098ec2dd90a4e3174a8d3ac18da487e9b9d1795a00fa0cd5766e2de052e2a4355c2ca0ec2ce35703db5d0322f0f09d785e7da575
6
+ metadata.gz: 935861b273a177c48be6f1559073a31fcb9f63bbff327950a72d54fbb141be6fa3408932ede9a4dd451b35f77daa6ef5f23ceb4f2f0457987fe0680b8d6faf65
7
+ data.tar.gz: e1a8cbb46fdc786a38faa7612bdb9970573e9dfddf633fb62e3fe0d9164440bf130499a53cb1562ab3805e18a3cd5dbbb17abfe37283ac318bea20a80719221a
data/README.md CHANGED
@@ -69,6 +69,11 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
79
  This library is supported on Ruby 2.5+.
@@ -1138,7 +1138,7 @@ module Google
1138
1138
  # @param options [::Gapic::CallOptions, ::Hash]
1139
1139
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1140
1140
  #
1141
- # @overload partition_query(parent: nil, structured_query: nil, partition_count: nil, page_token: nil, page_size: nil)
1141
+ # @overload partition_query(parent: nil, structured_query: nil, partition_count: nil, page_token: nil, page_size: nil, read_time: nil)
1142
1142
  # Pass arguments to `partition_query` via keyword arguments. Note that at
1143
1143
  # least one keyword argument is required. To specify no parameters, or to keep all
1144
1144
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1184,6 +1184,9 @@ module Google
1184
1184
  # to PartitionQuery will return up to 8 partitions and a `next_page_token`
1185
1185
  # if more results exist. A second call to PartitionQuery will return up to
1186
1186
  # 2 partitions, to complete the total of 10 specified in `partition_count`.
1187
+ # @param read_time [::Google::Protobuf::Timestamp, ::Hash]
1188
+ # Reads documents as they were at the given time.
1189
+ # This may not be older than 270 seconds.
1187
1190
  #
1188
1191
  # @yield [response, operation] Access the result along with the RPC operation
1189
1192
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::V1::Cursor>]
@@ -1425,7 +1428,7 @@ module Google
1425
1428
  # @param options [::Gapic::CallOptions, ::Hash]
1426
1429
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1427
1430
  #
1428
- # @overload list_collection_ids(parent: nil, page_size: nil, page_token: nil)
1431
+ # @overload list_collection_ids(parent: nil, page_size: nil, page_token: nil, read_time: nil)
1429
1432
  # Pass arguments to `list_collection_ids` via keyword arguments. Note that at
1430
1433
  # least one keyword argument is required. To specify no parameters, or to keep all
1431
1434
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1440,6 +1443,9 @@ module Google
1440
1443
  # @param page_token [::String]
1441
1444
  # A page token. Must be a value from
1442
1445
  # {::Google::Cloud::Firestore::V1::ListCollectionIdsResponse ListCollectionIdsResponse}.
1446
+ # @param read_time [::Google::Protobuf::Timestamp, ::Hash]
1447
+ # Reads documents as they were at the given time.
1448
+ # This may not be older than 270 seconds.
1443
1449
  #
1444
1450
  # @yield [response, operation] Access the result along with the RPC operation
1445
1451
  # @yieldparam response [::Google::Cloud::Firestore::V1::ListCollectionIdsResponse]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Firestore
23
23
  module V1
24
- VERSION = "0.4.7"
24
+ VERSION = "0.6.0"
25
25
  end
26
26
  end
27
27
  end
@@ -1,9 +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
4
  require 'google/protobuf'
6
5
 
6
+ require 'google/protobuf/timestamp_pb'
7
+
7
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
9
  add_file("google/firestore/v1/common.proto", :syntax => :proto3) do
9
10
  add_message "google.firestore.v1.DocumentMask" do
@@ -1,10 +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/protobuf'
8
9
 
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
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
@@ -120,6 +124,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
120
124
  oneof :query_type do
121
125
  optional :structured_query, :message, 2, "google.firestore.v1.StructuredQuery"
122
126
  end
127
+ oneof :consistency_selector do
128
+ optional :read_time, :message, 6, "google.protobuf.Timestamp"
129
+ end
123
130
  end
124
131
  add_message "google.firestore.v1.PartitionQueryResponse" do
125
132
  repeated :partitions, :message, 1, "google.firestore.v1.Cursor"
@@ -194,6 +201,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
194
201
  optional :parent, :string, 1
195
202
  optional :page_size, :int32, 2
196
203
  optional :page_token, :string, 3
204
+ oneof :consistency_selector do
205
+ optional :read_time, :message, 4, "google.protobuf.Timestamp"
206
+ end
197
207
  end
198
208
  add_message "google.firestore.v1.ListCollectionIdsResponse" do
199
209
  repeated :collection_ids, :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
+
4
6
  require 'google/api/field_behavior_pb'
5
7
  require 'google/firestore/v1/document_pb'
6
8
  require 'google/protobuf/wrappers_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,10 +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/protobuf'
8
9
 
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
11
  add_file("google/firestore/v1/write.proto", :syntax => :proto3) do
@@ -360,6 +360,10 @@ module Google
360
360
  # @return [::Integer]
361
361
  # The number of results that have been skipped due to an offset between
362
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.
363
367
  class RunQueryResponse
364
368
  include ::Google::Protobuf::MessageExts
365
369
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -412,6 +416,10 @@ module Google
412
416
  # to PartitionQuery will return up to 8 partitions and a `next_page_token`
413
417
  # if more results exist. A second call to PartitionQuery will return up to
414
418
  # 2 partitions, to complete the total of 10 specified in `partition_count`.
419
+ # @!attribute [rw] read_time
420
+ # @return [::Google::Protobuf::Timestamp]
421
+ # Reads documents as they were at the given time.
422
+ # This may not be older than 270 seconds.
415
423
  class PartitionQueryRequest
416
424
  include ::Google::Protobuf::MessageExts
417
425
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -726,6 +734,10 @@ module Google
726
734
  # @return [::String]
727
735
  # A page token. Must be a value from
728
736
  # {::Google::Cloud::Firestore::V1::ListCollectionIdsResponse ListCollectionIdsResponse}.
737
+ # @!attribute [rw] read_time
738
+ # @return [::Google::Protobuf::Timestamp]
739
+ # Reads documents as they were at the given time.
740
+ # This may not be older than 270 seconds.
729
741
  class ListCollectionIdsRequest
730
742
  include ::Google::Protobuf::MessageExts
731
743
  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.7
4
+ version: 0.6.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-03-07 00:00:00.000000000 Z
11
+ date: 2022-06-15 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.5
218
+ rubygems_version: 3.3.14
219
219
  signing_key:
220
220
  specification_version: 4
221
221
  summary: API Client library for the Cloud Firestore V1 API