google-apis-firestore_v1beta1 0.33.0 → 0.35.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: aae0a232d8df396c19747bd0ac8281cf3f1fd9410248df8048d2bfa7d434a836
4
- data.tar.gz: f39e0fc8f076b8a5daef6db65d65c2a03122841f9425ec05ba0a045396d45360
3
+ metadata.gz: b4d34f15128455e19009638af9112b57e8ab1b0483c0f2b0ff8e0ee18b2feba9
4
+ data.tar.gz: 212f987fb0b5784daa9831818ff5d1c155d0cee71d992acda0f4beb5defcdea3
5
5
  SHA512:
6
- metadata.gz: 6e0ce11834d12fce8a486a61f54684b85f8442d3936d59d200bde2c40da5e82791443f2b6b3d69d7a499f9b16632ecb6cab0a49e6c230462052356a7fdc63fe6
7
- data.tar.gz: 0e5530f782c77ec5a24f7ff153cb4d1232c3eac7f33159741b2f9c3c7908ba211a2d909c862a9619083a258d73792bcd15cda0b3c885591b6bd8dd21a987aec1
6
+ metadata.gz: 42fcf5102ac480640ec44bfbfb345e36e1a00898afed5d5919a16e12a13715e0558d94f2648fd202aa8782df179be8a97780a50712c24fcd91a7129a71d2372f
7
+ data.tar.gz: c78638b01e53786c97aaed1fa6c1634a731c7ba1db5de08bd5deca2bc892128b095561de7fbd145d659d842f948bdad939023192f51cab0a4e2b7df04afdac8e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-firestore_v1beta1
2
2
 
3
+ ### v0.35.0 (2024-01-23)
4
+
5
+ * Regenerated from discovery document revision 20240117
6
+ * Regenerated using generator version 0.13.0
7
+
8
+ ### v0.34.0 (2023-10-08)
9
+
10
+ * Regenerated from discovery document revision 20231002
11
+
3
12
  ### v0.33.0 (2023-09-10)
4
13
 
5
14
  * Regenerated from discovery document revision 20230905
@@ -588,7 +588,21 @@ module Google
588
588
  # @return [String]
589
589
  attr_accessor :create_time
590
590
 
591
- #
591
+ # The document's fields. The map keys represent field names. Field names
592
+ # matching the regular expression `__.*__` are reserved. Reserved field names
593
+ # are forbidden except in certain documented contexts. The field names,
594
+ # represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field
595
+ # paths may be used in other contexts to refer to structured fields defined here.
596
+ # For `map_value`, the field path is represented by a dot-delimited (`.`)
597
+ # string of segments. Each segment is either a simple field name (defined below)
598
+ # or a quoted field name. For example, the structured field `"foo" : ` map_value:
599
+ # ` "x&y" : ` string_value: "hello" ```` would be represented by the field path
600
+ # `` foo.`x&y` ``. A simple field name contains only characters `a` to `z`, `A`
601
+ # to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `
602
+ # foo_bar_17`. A quoted field name starts and ends with `` ` `` and may contain
603
+ # any character. Some characters, including `` ` ``, must be escaped using a `\`.
604
+ # For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents ``
605
+ # bak`tik ``.
592
606
  # Corresponds to the JSON property `fields`
593
607
  # @return [Hash<String,Google::Apis::FirestoreV1beta1::Value>]
594
608
  attr_accessor :fields
@@ -1833,7 +1847,8 @@ module Google
1833
1847
  # @return [String]
1834
1848
  attr_accessor :read_time
1835
1849
 
1836
- # A Firestore query.
1850
+ # A Firestore query. The query stages are executed in the following order: 1.
1851
+ # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
1837
1852
  # Corresponds to the JSON property `structuredQuery`
1838
1853
  # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
1839
1854
  attr_accessor :structured_query
@@ -1871,7 +1886,8 @@ module Google
1871
1886
  # PartitionQuery request returns partition cursors A and B, running the
1872
1887
  # following three queries will return the entire result set of the original
1873
1888
  # query: * query, end_at A * query, start_at A, end_at B * query, start_at B An
1874
- # empty result may indicate that the query has too few results to be partitioned.
1889
+ # empty result may indicate that the query has too few results to be partitioned,
1890
+ # or that the query is not yet supported for partitioning.
1875
1891
  # Corresponds to the JSON property `partitions`
1876
1892
  # @return [Array<Google::Apis::FirestoreV1beta1::Cursor>]
1877
1893
  attr_accessor :partitions
@@ -1935,6 +1951,27 @@ module Google
1935
1951
  end
1936
1952
  end
1937
1953
 
1954
+ # Plan for the query.
1955
+ class QueryPlan
1956
+ include Google::Apis::Core::Hashable
1957
+
1958
+ # Planning phase information for the query. It will include: ` "indexes_used": [
1959
+ # `"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"`, `"
1960
+ # query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"` ] `
1961
+ # Corresponds to the JSON property `planInfo`
1962
+ # @return [Hash<String,Object>]
1963
+ attr_accessor :plan_info
1964
+
1965
+ def initialize(**args)
1966
+ update!(**args)
1967
+ end
1968
+
1969
+ # Update properties of this object
1970
+ def update!(**args)
1971
+ @plan_info = args[:plan_info] if args.key?(:plan_info)
1972
+ end
1973
+ end
1974
+
1938
1975
  # A target specified by a query.
1939
1976
  class QueryTarget
1940
1977
  include Google::Apis::Core::Hashable
@@ -1948,7 +1985,8 @@ module Google
1948
1985
  # @return [String]
1949
1986
  attr_accessor :parent
1950
1987
 
1951
- # A Firestore query.
1988
+ # A Firestore query. The query stages are executed in the following order: 1.
1989
+ # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
1952
1990
  # Corresponds to the JSON property `structuredQuery`
1953
1991
  # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
1954
1992
  attr_accessor :structured_query
@@ -2007,6 +2045,35 @@ module Google
2007
2045
  end
2008
2046
  end
2009
2047
 
2048
+ # Planning and execution statistics for the query.
2049
+ class ResultSetStats
2050
+ include Google::Apis::Core::Hashable
2051
+
2052
+ # Plan for the query.
2053
+ # Corresponds to the JSON property `queryPlan`
2054
+ # @return [Google::Apis::FirestoreV1beta1::QueryPlan]
2055
+ attr_accessor :query_plan
2056
+
2057
+ # Aggregated statistics from the execution of the query. This will only be
2058
+ # present when the request specifies `PROFILE` mode. For example, a query will
2059
+ # return the statistics including: ` "results_returned": "20", "
2060
+ # documents_scanned": "20", "indexes_entries_scanned": "10050", "
2061
+ # total_execution_time": "100.7 msecs" `
2062
+ # Corresponds to the JSON property `queryStats`
2063
+ # @return [Hash<String,Object>]
2064
+ attr_accessor :query_stats
2065
+
2066
+ def initialize(**args)
2067
+ update!(**args)
2068
+ end
2069
+
2070
+ # Update properties of this object
2071
+ def update!(**args)
2072
+ @query_plan = args[:query_plan] if args.key?(:query_plan)
2073
+ @query_stats = args[:query_stats] if args.key?(:query_stats)
2074
+ end
2075
+ end
2076
+
2010
2077
  # The request for Firestore.Rollback.
2011
2078
  class RollbackRequest
2012
2079
  include Google::Apis::Core::Hashable
@@ -2031,6 +2098,13 @@ module Google
2031
2098
  class RunAggregationQueryRequest
2032
2099
  include Google::Apis::Core::Hashable
2033
2100
 
2101
+ # Optional. The mode in which the query request is processed. This field is
2102
+ # optional, and when not provided, it defaults to `NORMAL` mode where no
2103
+ # additional statistics will be returned with the query results.
2104
+ # Corresponds to the JSON property `mode`
2105
+ # @return [String]
2106
+ attr_accessor :mode
2107
+
2034
2108
  # Options for creating a new transaction.
2035
2109
  # Corresponds to the JSON property `newTransaction`
2036
2110
  # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
@@ -2061,6 +2135,7 @@ module Google
2061
2135
 
2062
2136
  # Update properties of this object
2063
2137
  def update!(**args)
2138
+ @mode = args[:mode] if args.key?(:mode)
2064
2139
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
2065
2140
  @read_time = args[:read_time] if args.key?(:read_time)
2066
2141
  @structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
@@ -2088,6 +2163,11 @@ module Google
2088
2163
  # @return [Google::Apis::FirestoreV1beta1::AggregationResult]
2089
2164
  attr_accessor :result
2090
2165
 
2166
+ # Planning and execution statistics for the query.
2167
+ # Corresponds to the JSON property `stats`
2168
+ # @return [Google::Apis::FirestoreV1beta1::ResultSetStats]
2169
+ attr_accessor :stats
2170
+
2091
2171
  # The transaction that was started as part of this request. Only present on the
2092
2172
  # first response when the request requested to start a new transaction.
2093
2173
  # Corresponds to the JSON property `transaction`
@@ -2103,6 +2183,7 @@ module Google
2103
2183
  def update!(**args)
2104
2184
  @read_time = args[:read_time] if args.key?(:read_time)
2105
2185
  @result = args[:result] if args.key?(:result)
2186
+ @stats = args[:stats] if args.key?(:stats)
2106
2187
  @transaction = args[:transaction] if args.key?(:transaction)
2107
2188
  end
2108
2189
  end
@@ -2111,6 +2192,13 @@ module Google
2111
2192
  class RunQueryRequest
2112
2193
  include Google::Apis::Core::Hashable
2113
2194
 
2195
+ # Optional. The mode in which the query request is processed. This field is
2196
+ # optional, and when not provided, it defaults to `NORMAL` mode where no
2197
+ # additional statistics will be returned with the query results.
2198
+ # Corresponds to the JSON property `mode`
2199
+ # @return [String]
2200
+ attr_accessor :mode
2201
+
2114
2202
  # Options for creating a new transaction.
2115
2203
  # Corresponds to the JSON property `newTransaction`
2116
2204
  # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
@@ -2123,7 +2211,8 @@ module Google
2123
2211
  # @return [String]
2124
2212
  attr_accessor :read_time
2125
2213
 
2126
- # A Firestore query.
2214
+ # A Firestore query. The query stages are executed in the following order: 1.
2215
+ # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
2127
2216
  # Corresponds to the JSON property `structuredQuery`
2128
2217
  # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
2129
2218
  attr_accessor :structured_query
@@ -2141,6 +2230,7 @@ module Google
2141
2230
 
2142
2231
  # Update properties of this object
2143
2232
  def update!(**args)
2233
+ @mode = args[:mode] if args.key?(:mode)
2144
2234
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
2145
2235
  @read_time = args[:read_time] if args.key?(:read_time)
2146
2236
  @structured_query = args[:structured_query] if args.key?(:structured_query)
@@ -2179,6 +2269,11 @@ module Google
2179
2269
  # @return [Fixnum]
2180
2270
  attr_accessor :skipped_results
2181
2271
 
2272
+ # Planning and execution statistics for the query.
2273
+ # Corresponds to the JSON property `stats`
2274
+ # @return [Google::Apis::FirestoreV1beta1::ResultSetStats]
2275
+ attr_accessor :stats
2276
+
2182
2277
  # The transaction that was started as part of this request. Can only be set in
2183
2278
  # the first response, and only if RunQueryRequest.new_transaction was set in the
2184
2279
  # request. If set, no other fields will be set in this response.
@@ -2197,6 +2292,7 @@ module Google
2197
2292
  @done = args[:done] if args.key?(:done)
2198
2293
  @read_time = args[:read_time] if args.key?(:read_time)
2199
2294
  @skipped_results = args[:skipped_results] if args.key?(:skipped_results)
2295
+ @stats = args[:stats] if args.key?(:stats)
2200
2296
  @transaction = args[:transaction] if args.key?(:transaction)
2201
2297
  end
2202
2298
  end
@@ -2251,7 +2347,8 @@ module Google
2251
2347
  # @return [Array<Google::Apis::FirestoreV1beta1::Aggregation>]
2252
2348
  attr_accessor :aggregations
2253
2349
 
2254
- # A Firestore query.
2350
+ # A Firestore query. The query stages are executed in the following order: 1.
2351
+ # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
2255
2352
  # Corresponds to the JSON property `structuredQuery`
2256
2353
  # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
2257
2354
  attr_accessor :structured_query
@@ -2267,7 +2364,8 @@ module Google
2267
2364
  end
2268
2365
  end
2269
2366
 
2270
- # A Firestore query.
2367
+ # A Firestore query. The query stages are executed in the following order: 1.
2368
+ # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
2271
2369
  class StructuredQuery
2272
2370
  include Google::Apis::Core::Hashable
2273
2371
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirestoreV1beta1
18
18
  # Version of the google-apis-firestore_v1beta1 gem
19
- GEM_VERSION = "0.33.0"
19
+ GEM_VERSION = "0.35.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.12.0"
22
+ GENERATOR_VERSION = "0.13.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230905"
25
+ REVISION = "20240117"
26
26
  end
27
27
  end
28
28
  end
@@ -382,6 +382,12 @@ module Google
382
382
  include Google::Apis::Core::JsonObjectSupport
383
383
  end
384
384
 
385
+ class QueryPlan
386
+ class Representation < Google::Apis::Core::JsonRepresentation; end
387
+
388
+ include Google::Apis::Core::JsonObjectSupport
389
+ end
390
+
385
391
  class QueryTarget
386
392
  class Representation < Google::Apis::Core::JsonRepresentation; end
387
393
 
@@ -400,6 +406,12 @@ module Google
400
406
  include Google::Apis::Core::JsonObjectSupport
401
407
  end
402
408
 
409
+ class ResultSetStats
410
+ class Representation < Google::Apis::Core::JsonRepresentation; end
411
+
412
+ include Google::Apis::Core::JsonObjectSupport
413
+ end
414
+
403
415
  class RollbackRequest
404
416
  class Representation < Google::Apis::Core::JsonRepresentation; end
405
417
 
@@ -1070,6 +1082,13 @@ module Google
1070
1082
  end
1071
1083
  end
1072
1084
 
1085
+ class QueryPlan
1086
+ # @private
1087
+ class Representation < Google::Apis::Core::JsonRepresentation
1088
+ hash :plan_info, as: 'planInfo'
1089
+ end
1090
+ end
1091
+
1073
1092
  class QueryTarget
1074
1093
  # @private
1075
1094
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1093,6 +1112,15 @@ module Google
1093
1112
  end
1094
1113
  end
1095
1114
 
1115
+ class ResultSetStats
1116
+ # @private
1117
+ class Representation < Google::Apis::Core::JsonRepresentation
1118
+ property :query_plan, as: 'queryPlan', class: Google::Apis::FirestoreV1beta1::QueryPlan, decorator: Google::Apis::FirestoreV1beta1::QueryPlan::Representation
1119
+
1120
+ hash :query_stats, as: 'queryStats'
1121
+ end
1122
+ end
1123
+
1096
1124
  class RollbackRequest
1097
1125
  # @private
1098
1126
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1103,6 +1131,7 @@ module Google
1103
1131
  class RunAggregationQueryRequest
1104
1132
  # @private
1105
1133
  class Representation < Google::Apis::Core::JsonRepresentation
1134
+ property :mode, as: 'mode'
1106
1135
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
1107
1136
 
1108
1137
  property :read_time, as: 'readTime'
@@ -1118,6 +1147,8 @@ module Google
1118
1147
  property :read_time, as: 'readTime'
1119
1148
  property :result, as: 'result', class: Google::Apis::FirestoreV1beta1::AggregationResult, decorator: Google::Apis::FirestoreV1beta1::AggregationResult::Representation
1120
1149
 
1150
+ property :stats, as: 'stats', class: Google::Apis::FirestoreV1beta1::ResultSetStats, decorator: Google::Apis::FirestoreV1beta1::ResultSetStats::Representation
1151
+
1121
1152
  property :transaction, :base64 => true, as: 'transaction'
1122
1153
  end
1123
1154
  end
@@ -1125,6 +1156,7 @@ module Google
1125
1156
  class RunQueryRequest
1126
1157
  # @private
1127
1158
  class Representation < Google::Apis::Core::JsonRepresentation
1159
+ property :mode, as: 'mode'
1128
1160
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
1129
1161
 
1130
1162
  property :read_time, as: 'readTime'
@@ -1142,6 +1174,8 @@ module Google
1142
1174
  property :done, as: 'done'
1143
1175
  property :read_time, as: 'readTime'
1144
1176
  property :skipped_results, as: 'skippedResults'
1177
+ property :stats, as: 'stats', class: Google::Apis::FirestoreV1beta1::ResultSetStats, decorator: Google::Apis::FirestoreV1beta1::ResultSetStats::Representation
1178
+
1145
1179
  property :transaction, :base64 => true, as: 'transaction'
1146
1180
  end
1147
1181
  end
@@ -33,6 +33,8 @@ module Google
33
33
  #
34
34
  # @see https://cloud.google.com/firestore
35
35
  class FirestoreService < Google::Apis::Core::BaseService
36
+ DEFAULT_ENDPOINT_TEMPLATE = "https://firestore.$UNIVERSE_DOMAIN$/"
37
+
36
38
  # @return [String]
37
39
  # API key. Your API key identifies your project and provides you with API access,
38
40
  # quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -44,7 +46,7 @@ module Google
44
46
  attr_accessor :quota_user
45
47
 
46
48
  def initialize
47
- super('https://firestore.googleapis.com/', '',
49
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
48
50
  client_name: 'google-apis-firestore_v1beta1',
49
51
  client_version: Google::Apis::FirestoreV1beta1::GEM_VERSION)
50
52
  @batch_path = 'batch'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firestore_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.33.0
4
+ version: 0.35.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: 2023-09-10 00:00:00.000000000 Z
11
+ date: 2024-01-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.11.0
19
+ version: 0.12.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.11.0
29
+ version: 0.12.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.33.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.35.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.4.19
78
+ rubygems_version: 3.5.3
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Firestore API V1beta1