google-apis-firestore_v1beta1 0.35.0 → 0.37.0

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: b4d34f15128455e19009638af9112b57e8ab1b0483c0f2b0ff8e0ee18b2feba9
4
- data.tar.gz: 212f987fb0b5784daa9831818ff5d1c155d0cee71d992acda0f4beb5defcdea3
3
+ metadata.gz: 76ecc92adc540edf809c95cb52b8fa816e7eba966b6c2ae2a6a493dadee1028a
4
+ data.tar.gz: 6d6fd2dc62af611b3c479f4da47eb3a69d89b45a0b7a34b4d8da1c5a594439c6
5
5
  SHA512:
6
- metadata.gz: 42fcf5102ac480640ec44bfbfb345e36e1a00898afed5d5919a16e12a13715e0558d94f2648fd202aa8782df179be8a97780a50712c24fcd91a7129a71d2372f
7
- data.tar.gz: c78638b01e53786c97aaed1fa6c1634a731c7ba1db5de08bd5deca2bc892128b095561de7fbd145d659d842f948bdad939023192f51cab0a4e2b7df04afdac8e
6
+ metadata.gz: 530fe9413e19bf5c4c0240da5a0162da199d5a01adcf1f11329d82b64af10b6ddf599e40fe5a3e6af4aa64529e986406b53deab720a777abe722974c044e2b83
7
+ data.tar.gz: 586eb2f58c592f8ddc60ce32ca98c2fb1760801743c9eb80b9f18e40c92a4f73054eb1ff1f637e4e5e9c2d47a477e8253a612f9c9a2d636cdc3d730e5e4dced3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-firestore_v1beta1
2
2
 
3
+ ### v0.37.0 (2024-02-18)
4
+
5
+ * Regenerated from discovery document revision 20240208
6
+
7
+ ### v0.36.0 (2024-02-11)
8
+
9
+ * Regenerated from discovery document revision 20240131
10
+ * Regenerated using generator version 0.13.1
11
+
3
12
  ### v0.35.0 (2024-01-23)
4
13
 
5
14
  * Regenerated from discovery document revision 20240117
@@ -869,6 +869,29 @@ module Google
869
869
  end
870
870
  end
871
871
 
872
+ # Explain options for the query.
873
+ class ExplainOptions
874
+ include Google::Apis::Core::Hashable
875
+
876
+ # Optional. Whether to execute this query. When false (the default), the query
877
+ # will be planned, returning only metrics from the planning stages. When true,
878
+ # the query will be planned and executed, returning the full query results along
879
+ # with both planning and execution stage metrics.
880
+ # Corresponds to the JSON property `analyze`
881
+ # @return [Boolean]
882
+ attr_accessor :analyze
883
+ alias_method :analyze?, :analyze
884
+
885
+ def initialize(**args)
886
+ update!(**args)
887
+ end
888
+
889
+ # Update properties of this object
890
+ def update!(**args)
891
+ @analyze = args[:analyze] if args.key?(:analyze)
892
+ end
893
+ end
894
+
872
895
  # A filter on a specific field.
873
896
  class FieldFilter
874
897
  include Google::Apis::Core::Hashable
@@ -1951,27 +1974,6 @@ module Google
1951
1974
  end
1952
1975
  end
1953
1976
 
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
-
1975
1977
  # A target specified by a query.
1976
1978
  class QueryTarget
1977
1979
  include Google::Apis::Core::Hashable
@@ -2045,35 +2047,6 @@ module Google
2045
2047
  end
2046
2048
  end
2047
2049
 
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
-
2077
2050
  # The request for Firestore.Rollback.
2078
2051
  class RollbackRequest
2079
2052
  include Google::Apis::Core::Hashable
@@ -2098,12 +2071,10 @@ module Google
2098
2071
  class RunAggregationQueryRequest
2099
2072
  include Google::Apis::Core::Hashable
2100
2073
 
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
2074
+ # Explain options for the query.
2075
+ # Corresponds to the JSON property `explainOptions`
2076
+ # @return [Google::Apis::FirestoreV1beta1::ExplainOptions]
2077
+ attr_accessor :explain_options
2107
2078
 
2108
2079
  # Options for creating a new transaction.
2109
2080
  # Corresponds to the JSON property `newTransaction`
@@ -2135,7 +2106,7 @@ module Google
2135
2106
 
2136
2107
  # Update properties of this object
2137
2108
  def update!(**args)
2138
- @mode = args[:mode] if args.key?(:mode)
2109
+ @explain_options = args[:explain_options] if args.key?(:explain_options)
2139
2110
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
2140
2111
  @read_time = args[:read_time] if args.key?(:read_time)
2141
2112
  @structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
@@ -2163,11 +2134,6 @@ module Google
2163
2134
  # @return [Google::Apis::FirestoreV1beta1::AggregationResult]
2164
2135
  attr_accessor :result
2165
2136
 
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
-
2171
2137
  # The transaction that was started as part of this request. Only present on the
2172
2138
  # first response when the request requested to start a new transaction.
2173
2139
  # Corresponds to the JSON property `transaction`
@@ -2183,7 +2149,6 @@ module Google
2183
2149
  def update!(**args)
2184
2150
  @read_time = args[:read_time] if args.key?(:read_time)
2185
2151
  @result = args[:result] if args.key?(:result)
2186
- @stats = args[:stats] if args.key?(:stats)
2187
2152
  @transaction = args[:transaction] if args.key?(:transaction)
2188
2153
  end
2189
2154
  end
@@ -2192,12 +2157,10 @@ module Google
2192
2157
  class RunQueryRequest
2193
2158
  include Google::Apis::Core::Hashable
2194
2159
 
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
2160
+ # Explain options for the query.
2161
+ # Corresponds to the JSON property `explainOptions`
2162
+ # @return [Google::Apis::FirestoreV1beta1::ExplainOptions]
2163
+ attr_accessor :explain_options
2201
2164
 
2202
2165
  # Options for creating a new transaction.
2203
2166
  # Corresponds to the JSON property `newTransaction`
@@ -2230,7 +2193,7 @@ module Google
2230
2193
 
2231
2194
  # Update properties of this object
2232
2195
  def update!(**args)
2233
- @mode = args[:mode] if args.key?(:mode)
2196
+ @explain_options = args[:explain_options] if args.key?(:explain_options)
2234
2197
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
2235
2198
  @read_time = args[:read_time] if args.key?(:read_time)
2236
2199
  @structured_query = args[:structured_query] if args.key?(:structured_query)
@@ -2269,11 +2232,6 @@ module Google
2269
2232
  # @return [Fixnum]
2270
2233
  attr_accessor :skipped_results
2271
2234
 
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
-
2277
2235
  # The transaction that was started as part of this request. Can only be set in
2278
2236
  # the first response, and only if RunQueryRequest.new_transaction was set in the
2279
2237
  # request. If set, no other fields will be set in this response.
@@ -2292,7 +2250,6 @@ module Google
2292
2250
  @done = args[:done] if args.key?(:done)
2293
2251
  @read_time = args[:read_time] if args.key?(:read_time)
2294
2252
  @skipped_results = args[:skipped_results] if args.key?(:skipped_results)
2295
- @stats = args[:stats] if args.key?(:stats)
2296
2253
  @transaction = args[:transaction] if args.key?(:transaction)
2297
2254
  end
2298
2255
  end
@@ -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.35.0"
19
+ GEM_VERSION = "0.37.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.13.0"
22
+ GENERATOR_VERSION = "0.13.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240117"
25
+ REVISION = "20240208"
26
26
  end
27
27
  end
28
28
  end
@@ -184,6 +184,12 @@ module Google
184
184
  include Google::Apis::Core::JsonObjectSupport
185
185
  end
186
186
 
187
+ class ExplainOptions
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
187
193
  class FieldFilter
188
194
  class Representation < Google::Apis::Core::JsonRepresentation; end
189
195
 
@@ -382,12 +388,6 @@ module Google
382
388
  include Google::Apis::Core::JsonObjectSupport
383
389
  end
384
390
 
385
- class QueryPlan
386
- class Representation < Google::Apis::Core::JsonRepresentation; end
387
-
388
- include Google::Apis::Core::JsonObjectSupport
389
- end
390
-
391
391
  class QueryTarget
392
392
  class Representation < Google::Apis::Core::JsonRepresentation; end
393
393
 
@@ -406,12 +406,6 @@ module Google
406
406
  include Google::Apis::Core::JsonObjectSupport
407
407
  end
408
408
 
409
- class ResultSetStats
410
- class Representation < Google::Apis::Core::JsonRepresentation; end
411
-
412
- include Google::Apis::Core::JsonObjectSupport
413
- end
414
-
415
409
  class RollbackRequest
416
410
  class Representation < Google::Apis::Core::JsonRepresentation; end
417
411
 
@@ -761,6 +755,13 @@ module Google
761
755
  end
762
756
  end
763
757
 
758
+ class ExplainOptions
759
+ # @private
760
+ class Representation < Google::Apis::Core::JsonRepresentation
761
+ property :analyze, as: 'analyze'
762
+ end
763
+ end
764
+
764
765
  class FieldFilter
765
766
  # @private
766
767
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1082,13 +1083,6 @@ module Google
1082
1083
  end
1083
1084
  end
1084
1085
 
1085
- class QueryPlan
1086
- # @private
1087
- class Representation < Google::Apis::Core::JsonRepresentation
1088
- hash :plan_info, as: 'planInfo'
1089
- end
1090
- end
1091
-
1092
1086
  class QueryTarget
1093
1087
  # @private
1094
1088
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1112,15 +1106,6 @@ module Google
1112
1106
  end
1113
1107
  end
1114
1108
 
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
-
1124
1109
  class RollbackRequest
1125
1110
  # @private
1126
1111
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1131,7 +1116,8 @@ module Google
1131
1116
  class RunAggregationQueryRequest
1132
1117
  # @private
1133
1118
  class Representation < Google::Apis::Core::JsonRepresentation
1134
- property :mode, as: 'mode'
1119
+ property :explain_options, as: 'explainOptions', class: Google::Apis::FirestoreV1beta1::ExplainOptions, decorator: Google::Apis::FirestoreV1beta1::ExplainOptions::Representation
1120
+
1135
1121
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
1136
1122
 
1137
1123
  property :read_time, as: 'readTime'
@@ -1147,8 +1133,6 @@ module Google
1147
1133
  property :read_time, as: 'readTime'
1148
1134
  property :result, as: 'result', class: Google::Apis::FirestoreV1beta1::AggregationResult, decorator: Google::Apis::FirestoreV1beta1::AggregationResult::Representation
1149
1135
 
1150
- property :stats, as: 'stats', class: Google::Apis::FirestoreV1beta1::ResultSetStats, decorator: Google::Apis::FirestoreV1beta1::ResultSetStats::Representation
1151
-
1152
1136
  property :transaction, :base64 => true, as: 'transaction'
1153
1137
  end
1154
1138
  end
@@ -1156,7 +1140,8 @@ module Google
1156
1140
  class RunQueryRequest
1157
1141
  # @private
1158
1142
  class Representation < Google::Apis::Core::JsonRepresentation
1159
- property :mode, as: 'mode'
1143
+ property :explain_options, as: 'explainOptions', class: Google::Apis::FirestoreV1beta1::ExplainOptions, decorator: Google::Apis::FirestoreV1beta1::ExplainOptions::Representation
1144
+
1160
1145
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
1161
1146
 
1162
1147
  property :read_time, as: 'readTime'
@@ -1174,8 +1159,6 @@ module Google
1174
1159
  property :done, as: 'done'
1175
1160
  property :read_time, as: 'readTime'
1176
1161
  property :skipped_results, as: 'skippedResults'
1177
- property :stats, as: 'stats', class: Google::Apis::FirestoreV1beta1::ResultSetStats, decorator: Google::Apis::FirestoreV1beta1::ResultSetStats::Representation
1178
-
1179
1162
  property :transaction, :base64 => true, as: 'transaction'
1180
1163
  end
1181
1164
  end
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.35.0
4
+ version: 0.37.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: 2024-01-23 00:00:00.000000000 Z
11
+ date: 2024-02-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -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.35.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.37.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: []