google-apis-firestore_v1beta1 0.47.0 → 0.49.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: 46c2f7b74e285854d355c81b957ffa412b96a55d79dc5af5cf09fe9eeb4b3dac
4
- data.tar.gz: 21c71004115fb4ecce768d5a1eaa93ebe8c86c41be45bc891d77624ffb319554
3
+ metadata.gz: d0a662620bde5df867d729a2fb6de140b74ef18fb93b0be016c83631b9b59c50
4
+ data.tar.gz: ccce7ddf4863168a063377f584ac60a55ef587de165672a698e15c4e03c65a1d
5
5
  SHA512:
6
- metadata.gz: a1139a874349029c37efc120997d1e788703c49cc31ff6edeea90a2437b916371f8ce29fe8044ae815e5e01ab0b96e3d77bcc7bfc3bacb16bef882005b3aa8d9
7
- data.tar.gz: 95c873b54a69fea6c48fca75eb7c812f1b737a3b392f3a13440b40fe6c952ea2569596d599b672a0d01943f4ccbdd3ab5e191240320a07028f40d60b13147efc
6
+ metadata.gz: ad7981418af0fb604b89771ca5059537101d807f5905fffc94a208df998f5236f811ae9f2c788860c9b392aeef9bf4c7daa6baaac48cf1ffe31b7c492dcd61ec
7
+ data.tar.gz: 3982374241697226de7578b1e1eae43aaf4ae08cbeb5987f8fca02de3f9a834e69139ab48b09faadf089b7dda10cb5bd0d594fdabf7ee57931c1f40e54fc39d6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-firestore_v1beta1
2
2
 
3
+ ### v0.49.0 (2025-12-21)
4
+
5
+ * Regenerated from discovery document revision 20251216
6
+
7
+ ### v0.48.0 (2025-06-29)
8
+
9
+ * Regenerated from discovery document revision 20250618
10
+ * Regenerated using generator version 0.18.0
11
+
3
12
  ### v0.47.0 (2025-05-04)
4
13
 
5
14
  * Regenerated using generator version 0.17.0
@@ -826,6 +826,104 @@ module Google
826
826
  end
827
827
  end
828
828
 
829
+ # The request for Firestore.ExecutePipeline.
830
+ class ExecutePipelineRequest
831
+ include Google::Apis::Core::Hashable
832
+
833
+ # Options for creating a new transaction.
834
+ # Corresponds to the JSON property `newTransaction`
835
+ # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
836
+ attr_accessor :new_transaction
837
+
838
+ # Execute the pipeline in a snapshot transaction at the given time. This must be
839
+ # a microsecond precision timestamp within the past one hour, or if Point-in-
840
+ # Time Recovery is enabled, can additionally be a whole minute timestamp within
841
+ # the past 7 days.
842
+ # Corresponds to the JSON property `readTime`
843
+ # @return [String]
844
+ attr_accessor :read_time
845
+
846
+ # A Firestore query represented as an ordered list of operations / stages. This
847
+ # is considered the top-level function which plans and executes a query. It is
848
+ # logically equivalent to `query(stages, options)`, but prevents the client from
849
+ # having to build a function wrapper.
850
+ # Corresponds to the JSON property `structuredPipeline`
851
+ # @return [Google::Apis::FirestoreV1beta1::StructuredPipeline]
852
+ attr_accessor :structured_pipeline
853
+
854
+ # Run the query within an already active transaction. The value here is the
855
+ # opaque transaction ID to execute the query in.
856
+ # Corresponds to the JSON property `transaction`
857
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
858
+ # @return [String]
859
+ attr_accessor :transaction
860
+
861
+ def initialize(**args)
862
+ update!(**args)
863
+ end
864
+
865
+ # Update properties of this object
866
+ def update!(**args)
867
+ @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
868
+ @read_time = args[:read_time] if args.key?(:read_time)
869
+ @structured_pipeline = args[:structured_pipeline] if args.key?(:structured_pipeline)
870
+ @transaction = args[:transaction] if args.key?(:transaction)
871
+ end
872
+ end
873
+
874
+ # The response for Firestore.Execute.
875
+ class ExecutePipelineResponse
876
+ include Google::Apis::Core::Hashable
877
+
878
+ # The time at which the results are valid. This is a (not strictly)
879
+ # monotonically increasing value across multiple responses in the same stream.
880
+ # The API guarantees that all previously returned results are still valid at the
881
+ # latest `execution_time`. This allows the API consumer to treat the query if it
882
+ # ran at the latest `execution_time` returned. If the query returns no results,
883
+ # a response with `execution_time` and no `results` will be sent, and this
884
+ # represents the time at which the operation was run.
885
+ # Corresponds to the JSON property `executionTime`
886
+ # @return [String]
887
+ attr_accessor :execution_time
888
+
889
+ # Pipeline explain stats. Depending on the explain options in the original
890
+ # request, this can contain the optimized plan and / or execution stats.
891
+ # Corresponds to the JSON property `explainStats`
892
+ # @return [Google::Apis::FirestoreV1beta1::ExplainStats]
893
+ attr_accessor :explain_stats
894
+
895
+ # An ordered batch of results returned executing a pipeline. The batch size is
896
+ # variable, and can even be zero for when only a partial progress message is
897
+ # returned. The fields present in the returned documents are only those that
898
+ # were explicitly requested in the pipeline, this includes those like `__name__`
899
+ # and `__update_time__`. This is explicitly a divergence from `Firestore.
900
+ # RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even
901
+ # when they are not specified in the `mask`.
902
+ # Corresponds to the JSON property `results`
903
+ # @return [Array<Google::Apis::FirestoreV1beta1::Document>]
904
+ attr_accessor :results
905
+
906
+ # Newly created transaction identifier. This field is only specified as part of
907
+ # the first response from the server, alongside the `results` field when the
908
+ # original request specified ExecuteRequest.new_transaction.
909
+ # Corresponds to the JSON property `transaction`
910
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
911
+ # @return [String]
912
+ attr_accessor :transaction
913
+
914
+ def initialize(**args)
915
+ update!(**args)
916
+ end
917
+
918
+ # Update properties of this object
919
+ def update!(**args)
920
+ @execution_time = args[:execution_time] if args.key?(:execution_time)
921
+ @explain_stats = args[:explain_stats] if args.key?(:explain_stats)
922
+ @results = args[:results] if args.key?(:results)
923
+ @transaction = args[:transaction] if args.key?(:transaction)
924
+ end
925
+ end
926
+
829
927
  # Execution statistics for the query.
830
928
  class ExecutionStats
831
929
  include Google::Apis::Core::Hashable
@@ -959,6 +1057,28 @@ module Google
959
1057
  end
960
1058
  end
961
1059
 
1060
+ # Pipeline explain stats. Depending on the explain options in the original
1061
+ # request, this can contain the optimized plan and / or execution stats.
1062
+ class ExplainStats
1063
+ include Google::Apis::Core::Hashable
1064
+
1065
+ # The format depends on the `output_format` options in the request. Currently
1066
+ # there are two supported options: `TEXT` and `JSON`. Both supply a `google.
1067
+ # protobuf.StringValue`.
1068
+ # Corresponds to the JSON property `data`
1069
+ # @return [Hash<String,Object>]
1070
+ attr_accessor :data
1071
+
1072
+ def initialize(**args)
1073
+ update!(**args)
1074
+ end
1075
+
1076
+ # Update properties of this object
1077
+ def update!(**args)
1078
+ @data = args[:data] if args.key?(:data)
1079
+ end
1080
+ end
1081
+
962
1082
  # A filter on a specific field.
963
1083
  class FieldFilter
964
1084
  include Google::Apis::Core::Hashable
@@ -1156,6 +1276,40 @@ module Google
1156
1276
  end
1157
1277
  end
1158
1278
 
1279
+ # Represents an unevaluated scalar expression. For example, the expression `like(
1280
+ # user_name, "%alice%")` is represented as: ``` name: "like" args `
1281
+ # field_reference: "user_name" ` args ` string_value: "%alice%" ` ```
1282
+ class Function
1283
+ include Google::Apis::Core::Hashable
1284
+
1285
+ # Optional. Ordered list of arguments the given function expects.
1286
+ # Corresponds to the JSON property `args`
1287
+ # @return [Array<Google::Apis::FirestoreV1beta1::Value>]
1288
+ attr_accessor :args
1289
+
1290
+ # Required. The name of the function to evaluate. **Requires:** * must be in
1291
+ # snake case (lower case with underscore separator).
1292
+ # Corresponds to the JSON property `name`
1293
+ # @return [String]
1294
+ attr_accessor :name
1295
+
1296
+ # Optional. Optional named arguments that certain functions may support.
1297
+ # Corresponds to the JSON property `options`
1298
+ # @return [Hash<String,Google::Apis::FirestoreV1beta1::Value>]
1299
+ attr_accessor :options
1300
+
1301
+ def initialize(**args)
1302
+ update!(**args)
1303
+ end
1304
+
1305
+ # Update properties of this object
1306
+ def update!(**args)
1307
+ @args = args[:args] if args.key?(:args)
1308
+ @name = args[:name] if args.key?(:name)
1309
+ @options = args[:options] if args.key?(:options)
1310
+ end
1311
+ end
1312
+
1159
1313
  # Metadata for google.longrunning.Operation results from FirestoreAdmin.
1160
1314
  # BulkDeleteDocuments.
1161
1315
  class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
@@ -1223,6 +1377,60 @@ module Google
1223
1377
  end
1224
1378
  end
1225
1379
 
1380
+ # Metadata for the long-running operation from the CloneDatabase request.
1381
+ class GoogleFirestoreAdminV1CloneDatabaseMetadata
1382
+ include Google::Apis::Core::Hashable
1383
+
1384
+ # The name of the database being cloned to.
1385
+ # Corresponds to the JSON property `database`
1386
+ # @return [String]
1387
+ attr_accessor :database
1388
+
1389
+ # The time the clone finished, unset for ongoing clones.
1390
+ # Corresponds to the JSON property `endTime`
1391
+ # @return [String]
1392
+ attr_accessor :end_time
1393
+
1394
+ # The operation state of the clone.
1395
+ # Corresponds to the JSON property `operationState`
1396
+ # @return [String]
1397
+ attr_accessor :operation_state
1398
+
1399
+ # A consistent snapshot of a database at a specific point in time. A PITR (Point-
1400
+ # in-time recovery) snapshot with previous versions of a database's data is
1401
+ # available for every minute up to the associated database's data retention
1402
+ # period. If the PITR feature is enabled, the retention period is 7 days;
1403
+ # otherwise, it is one hour.
1404
+ # Corresponds to the JSON property `pitrSnapshot`
1405
+ # @return [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1PitrSnapshot]
1406
+ attr_accessor :pitr_snapshot
1407
+
1408
+ # Describes the progress of the operation. Unit of work is generic and must be
1409
+ # interpreted based on where Progress is used.
1410
+ # Corresponds to the JSON property `progressPercentage`
1411
+ # @return [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1Progress]
1412
+ attr_accessor :progress_percentage
1413
+
1414
+ # The time the clone was started.
1415
+ # Corresponds to the JSON property `startTime`
1416
+ # @return [String]
1417
+ attr_accessor :start_time
1418
+
1419
+ def initialize(**args)
1420
+ update!(**args)
1421
+ end
1422
+
1423
+ # Update properties of this object
1424
+ def update!(**args)
1425
+ @database = args[:database] if args.key?(:database)
1426
+ @end_time = args[:end_time] if args.key?(:end_time)
1427
+ @operation_state = args[:operation_state] if args.key?(:operation_state)
1428
+ @pitr_snapshot = args[:pitr_snapshot] if args.key?(:pitr_snapshot)
1429
+ @progress_percentage = args[:progress_percentage] if args.key?(:progress_percentage)
1430
+ @start_time = args[:start_time] if args.key?(:start_time)
1431
+ end
1432
+ end
1433
+
1226
1434
  # Metadata related to the create database operation.
1227
1435
  class GoogleFirestoreAdminV1CreateDatabaseMetadata
1228
1436
  include Google::Apis::Core::Hashable
@@ -1249,6 +1457,43 @@ module Google
1249
1457
  end
1250
1458
  end
1251
1459
 
1460
+ # A consistent snapshot of a database at a specific point in time. A PITR (Point-
1461
+ # in-time recovery) snapshot with previous versions of a database's data is
1462
+ # available for every minute up to the associated database's data retention
1463
+ # period. If the PITR feature is enabled, the retention period is 7 days;
1464
+ # otherwise, it is one hour.
1465
+ class GoogleFirestoreAdminV1PitrSnapshot
1466
+ include Google::Apis::Core::Hashable
1467
+
1468
+ # Required. The name of the database that this was a snapshot of. Format: `
1469
+ # projects/`project`/databases/`database``.
1470
+ # Corresponds to the JSON property `database`
1471
+ # @return [String]
1472
+ attr_accessor :database
1473
+
1474
+ # Output only. Public UUID of the database the snapshot was associated with.
1475
+ # Corresponds to the JSON property `databaseUid`
1476
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
1477
+ # @return [String]
1478
+ attr_accessor :database_uid
1479
+
1480
+ # Required. Snapshot time of the database.
1481
+ # Corresponds to the JSON property `snapshotTime`
1482
+ # @return [String]
1483
+ attr_accessor :snapshot_time
1484
+
1485
+ def initialize(**args)
1486
+ update!(**args)
1487
+ end
1488
+
1489
+ # Update properties of this object
1490
+ def update!(**args)
1491
+ @database = args[:database] if args.key?(:database)
1492
+ @database_uid = args[:database_uid] if args.key?(:database_uid)
1493
+ @snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
1494
+ end
1495
+ end
1496
+
1252
1497
  # Describes the progress of the operation. Unit of work is generic and must be
1253
1498
  # interpreted based on where Progress is used.
1254
1499
  class GoogleFirestoreAdminV1Progress
@@ -2120,6 +2365,25 @@ module Google
2120
2365
  end
2121
2366
  end
2122
2367
 
2368
+ # A Firestore query represented as an ordered list of operations / stages.
2369
+ class Pipeline
2370
+ include Google::Apis::Core::Hashable
2371
+
2372
+ # Required. Ordered list of stages to evaluate.
2373
+ # Corresponds to the JSON property `stages`
2374
+ # @return [Array<Google::Apis::FirestoreV1beta1::Stage>]
2375
+ attr_accessor :stages
2376
+
2377
+ def initialize(**args)
2378
+ update!(**args)
2379
+ end
2380
+
2381
+ # Update properties of this object
2382
+ def update!(**args)
2383
+ @stages = args[:stages] if args.key?(:stages)
2384
+ end
2385
+ end
2386
+
2123
2387
  # Planning phase information for the query.
2124
2388
  class PlanSummary
2125
2389
  include Google::Apis::Core::Hashable
@@ -2483,6 +2747,43 @@ module Google
2483
2747
  end
2484
2748
  end
2485
2749
 
2750
+ # A single operation within a pipeline. A stage is made up of a unique name, and
2751
+ # a list of arguments. The exact number of arguments & types is dependent on the
2752
+ # stage type. To give an example, the stage `filter(state = "MD")` would be
2753
+ # encoded as: ``` name: "filter" args ` function_value ` name: "eq" args `
2754
+ # field_reference_value: "state" ` args ` string_value: "MD" ` ` ` ``` See
2755
+ # public documentation for the full list.
2756
+ class Stage
2757
+ include Google::Apis::Core::Hashable
2758
+
2759
+ # Optional. Ordered list of arguments the given stage expects.
2760
+ # Corresponds to the JSON property `args`
2761
+ # @return [Array<Google::Apis::FirestoreV1beta1::Value>]
2762
+ attr_accessor :args
2763
+
2764
+ # Required. The name of the stage to evaluate. **Requires:** * must be in snake
2765
+ # case (lower case with underscore separator).
2766
+ # Corresponds to the JSON property `name`
2767
+ # @return [String]
2768
+ attr_accessor :name
2769
+
2770
+ # Optional. Optional named arguments that certain functions may support.
2771
+ # Corresponds to the JSON property `options`
2772
+ # @return [Hash<String,Google::Apis::FirestoreV1beta1::Value>]
2773
+ attr_accessor :options
2774
+
2775
+ def initialize(**args)
2776
+ update!(**args)
2777
+ end
2778
+
2779
+ # Update properties of this object
2780
+ def update!(**args)
2781
+ @args = args[:args] if args.key?(:args)
2782
+ @name = args[:name] if args.key?(:name)
2783
+ @options = args[:options] if args.key?(:options)
2784
+ end
2785
+ end
2786
+
2486
2787
  # The `Status` type defines a logical error model that is suitable for different
2487
2788
  # programming environments, including REST APIs and RPC APIs. It is used by [
2488
2789
  # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
@@ -2551,6 +2852,34 @@ module Google
2551
2852
  end
2552
2853
  end
2553
2854
 
2855
+ # A Firestore query represented as an ordered list of operations / stages. This
2856
+ # is considered the top-level function which plans and executes a query. It is
2857
+ # logically equivalent to `query(stages, options)`, but prevents the client from
2858
+ # having to build a function wrapper.
2859
+ class StructuredPipeline
2860
+ include Google::Apis::Core::Hashable
2861
+
2862
+ # Optional. Optional query-level arguments.
2863
+ # Corresponds to the JSON property `options`
2864
+ # @return [Hash<String,Google::Apis::FirestoreV1beta1::Value>]
2865
+ attr_accessor :options
2866
+
2867
+ # A Firestore query represented as an ordered list of operations / stages.
2868
+ # Corresponds to the JSON property `pipeline`
2869
+ # @return [Google::Apis::FirestoreV1beta1::Pipeline]
2870
+ attr_accessor :pipeline
2871
+
2872
+ def initialize(**args)
2873
+ update!(**args)
2874
+ end
2875
+
2876
+ # Update properties of this object
2877
+ def update!(**args)
2878
+ @options = args[:options] if args.key?(:options)
2879
+ @pipeline = args[:pipeline] if args.key?(:pipeline)
2880
+ end
2881
+ end
2882
+
2554
2883
  # A Firestore query. The query stages are executed in the following order: 1.
2555
2884
  # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
2556
2885
  # find_nearest
@@ -2879,6 +3208,21 @@ module Google
2879
3208
  # @return [Float]
2880
3209
  attr_accessor :double_value
2881
3210
 
3211
+ # Value which references a field. This is considered relative (vs absolute)
3212
+ # since it only refers to a field and not a field within a particular document. *
3213
+ # *Requires:** * Must follow field reference limitations. * Not allowed to be
3214
+ # used when writing documents.
3215
+ # Corresponds to the JSON property `fieldReferenceValue`
3216
+ # @return [String]
3217
+ attr_accessor :field_reference_value
3218
+
3219
+ # Represents an unevaluated scalar expression. For example, the expression `like(
3220
+ # user_name, "%alice%")` is represented as: ``` name: "like" args `
3221
+ # field_reference: "user_name" ` args ` string_value: "%alice%" ` ```
3222
+ # Corresponds to the JSON property `functionValue`
3223
+ # @return [Google::Apis::FirestoreV1beta1::Function]
3224
+ attr_accessor :function_value
3225
+
2882
3226
  # An object that represents a latitude/longitude pair. This is expressed as a
2883
3227
  # pair of doubles to represent degrees latitude and degrees longitude. Unless
2884
3228
  # specified otherwise, this object must conform to the WGS84 standard. Values
@@ -2902,6 +3246,11 @@ module Google
2902
3246
  # @return [String]
2903
3247
  attr_accessor :null_value
2904
3248
 
3249
+ # A Firestore query represented as an ordered list of operations / stages.
3250
+ # Corresponds to the JSON property `pipelineValue`
3251
+ # @return [Google::Apis::FirestoreV1beta1::Pipeline]
3252
+ attr_accessor :pipeline_value
3253
+
2905
3254
  # A reference to a document. For example: `projects/`project_id`/databases/`
2906
3255
  # database_id`/documents/`document_path``.
2907
3256
  # Corresponds to the JSON property `referenceValue`
@@ -2931,10 +3280,13 @@ module Google
2931
3280
  @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
2932
3281
  @bytes_value = args[:bytes_value] if args.key?(:bytes_value)
2933
3282
  @double_value = args[:double_value] if args.key?(:double_value)
3283
+ @field_reference_value = args[:field_reference_value] if args.key?(:field_reference_value)
3284
+ @function_value = args[:function_value] if args.key?(:function_value)
2934
3285
  @geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value)
2935
3286
  @integer_value = args[:integer_value] if args.key?(:integer_value)
2936
3287
  @map_value = args[:map_value] if args.key?(:map_value)
2937
3288
  @null_value = args[:null_value] if args.key?(:null_value)
3289
+ @pipeline_value = args[:pipeline_value] if args.key?(:pipeline_value)
2938
3290
  @reference_value = args[:reference_value] if args.key?(:reference_value)
2939
3291
  @string_value = args[:string_value] if args.key?(:string_value)
2940
3292
  @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value)
@@ -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.47.0"
19
+ GEM_VERSION = "0.49.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.17.0"
22
+ GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250307"
25
+ REVISION = "20251216"
26
26
  end
27
27
  end
28
28
  end
@@ -178,6 +178,18 @@ module Google
178
178
  include Google::Apis::Core::JsonObjectSupport
179
179
  end
180
180
 
181
+ class ExecutePipelineRequest
182
+ class Representation < Google::Apis::Core::JsonRepresentation; end
183
+
184
+ include Google::Apis::Core::JsonObjectSupport
185
+ end
186
+
187
+ class ExecutePipelineResponse
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
181
193
  class ExecutionStats
182
194
  class Representation < Google::Apis::Core::JsonRepresentation; end
183
195
 
@@ -202,6 +214,12 @@ module Google
202
214
  include Google::Apis::Core::JsonObjectSupport
203
215
  end
204
216
 
217
+ class ExplainStats
218
+ class Representation < Google::Apis::Core::JsonRepresentation; end
219
+
220
+ include Google::Apis::Core::JsonObjectSupport
221
+ end
222
+
205
223
  class FieldFilter
206
224
  class Representation < Google::Apis::Core::JsonRepresentation; end
207
225
 
@@ -232,12 +250,24 @@ module Google
232
250
  include Google::Apis::Core::JsonObjectSupport
233
251
  end
234
252
 
253
+ class Function
254
+ class Representation < Google::Apis::Core::JsonRepresentation; end
255
+
256
+ include Google::Apis::Core::JsonObjectSupport
257
+ end
258
+
235
259
  class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
236
260
  class Representation < Google::Apis::Core::JsonRepresentation; end
237
261
 
238
262
  include Google::Apis::Core::JsonObjectSupport
239
263
  end
240
264
 
265
+ class GoogleFirestoreAdminV1CloneDatabaseMetadata
266
+ class Representation < Google::Apis::Core::JsonRepresentation; end
267
+
268
+ include Google::Apis::Core::JsonObjectSupport
269
+ end
270
+
241
271
  class GoogleFirestoreAdminV1CreateDatabaseMetadata
242
272
  class Representation < Google::Apis::Core::JsonRepresentation; end
243
273
 
@@ -250,6 +280,12 @@ module Google
250
280
  include Google::Apis::Core::JsonObjectSupport
251
281
  end
252
282
 
283
+ class GoogleFirestoreAdminV1PitrSnapshot
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
253
289
  class GoogleFirestoreAdminV1Progress
254
290
  class Representation < Google::Apis::Core::JsonRepresentation; end
255
291
 
@@ -400,6 +436,12 @@ module Google
400
436
  include Google::Apis::Core::JsonObjectSupport
401
437
  end
402
438
 
439
+ class Pipeline
440
+ class Representation < Google::Apis::Core::JsonRepresentation; end
441
+
442
+ include Google::Apis::Core::JsonObjectSupport
443
+ end
444
+
403
445
  class PlanSummary
404
446
  class Representation < Google::Apis::Core::JsonRepresentation; end
405
447
 
@@ -466,6 +508,12 @@ module Google
466
508
  include Google::Apis::Core::JsonObjectSupport
467
509
  end
468
510
 
511
+ class Stage
512
+ class Representation < Google::Apis::Core::JsonRepresentation; end
513
+
514
+ include Google::Apis::Core::JsonObjectSupport
515
+ end
516
+
469
517
  class Status
470
518
  class Representation < Google::Apis::Core::JsonRepresentation; end
471
519
 
@@ -478,6 +526,12 @@ module Google
478
526
  include Google::Apis::Core::JsonObjectSupport
479
527
  end
480
528
 
529
+ class StructuredPipeline
530
+ class Representation < Google::Apis::Core::JsonRepresentation; end
531
+
532
+ include Google::Apis::Core::JsonObjectSupport
533
+ end
534
+
481
535
  class StructuredQuery
482
536
  class Representation < Google::Apis::Core::JsonRepresentation; end
483
537
 
@@ -775,6 +829,30 @@ module Google
775
829
  end
776
830
  end
777
831
 
832
+ class ExecutePipelineRequest
833
+ # @private
834
+ class Representation < Google::Apis::Core::JsonRepresentation
835
+ property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
836
+
837
+ property :read_time, as: 'readTime'
838
+ property :structured_pipeline, as: 'structuredPipeline', class: Google::Apis::FirestoreV1beta1::StructuredPipeline, decorator: Google::Apis::FirestoreV1beta1::StructuredPipeline::Representation
839
+
840
+ property :transaction, :base64 => true, as: 'transaction'
841
+ end
842
+ end
843
+
844
+ class ExecutePipelineResponse
845
+ # @private
846
+ class Representation < Google::Apis::Core::JsonRepresentation
847
+ property :execution_time, as: 'executionTime'
848
+ property :explain_stats, as: 'explainStats', class: Google::Apis::FirestoreV1beta1::ExplainStats, decorator: Google::Apis::FirestoreV1beta1::ExplainStats::Representation
849
+
850
+ collection :results, as: 'results', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
851
+
852
+ property :transaction, :base64 => true, as: 'transaction'
853
+ end
854
+ end
855
+
778
856
  class ExecutionStats
779
857
  # @private
780
858
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -812,6 +890,13 @@ module Google
812
890
  end
813
891
  end
814
892
 
893
+ class ExplainStats
894
+ # @private
895
+ class Representation < Google::Apis::Core::JsonRepresentation
896
+ hash :data, as: 'data'
897
+ end
898
+ end
899
+
815
900
  class FieldFilter
816
901
  # @private
817
902
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -874,6 +959,17 @@ module Google
874
959
  end
875
960
  end
876
961
 
962
+ class Function
963
+ # @private
964
+ class Representation < Google::Apis::Core::JsonRepresentation
965
+ collection :args, as: 'args', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
966
+
967
+ property :name, as: 'name'
968
+ hash :options, as: 'options', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
969
+
970
+ end
971
+ end
972
+
877
973
  class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
878
974
  # @private
879
975
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -890,6 +986,20 @@ module Google
890
986
  end
891
987
  end
892
988
 
989
+ class GoogleFirestoreAdminV1CloneDatabaseMetadata
990
+ # @private
991
+ class Representation < Google::Apis::Core::JsonRepresentation
992
+ property :database, as: 'database'
993
+ property :end_time, as: 'endTime'
994
+ property :operation_state, as: 'operationState'
995
+ property :pitr_snapshot, as: 'pitrSnapshot', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1PitrSnapshot, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1PitrSnapshot::Representation
996
+
997
+ property :progress_percentage, as: 'progressPercentage', class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1Progress::Representation
998
+
999
+ property :start_time, as: 'startTime'
1000
+ end
1001
+ end
1002
+
893
1003
  class GoogleFirestoreAdminV1CreateDatabaseMetadata
894
1004
  # @private
895
1005
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -902,6 +1012,15 @@ module Google
902
1012
  end
903
1013
  end
904
1014
 
1015
+ class GoogleFirestoreAdminV1PitrSnapshot
1016
+ # @private
1017
+ class Representation < Google::Apis::Core::JsonRepresentation
1018
+ property :database, as: 'database'
1019
+ property :database_uid, :base64 => true, as: 'databaseUid'
1020
+ property :snapshot_time, as: 'snapshotTime'
1021
+ end
1022
+ end
1023
+
905
1024
  class GoogleFirestoreAdminV1Progress
906
1025
  # @private
907
1026
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1147,6 +1266,14 @@ module Google
1147
1266
  end
1148
1267
  end
1149
1268
 
1269
+ class Pipeline
1270
+ # @private
1271
+ class Representation < Google::Apis::Core::JsonRepresentation
1272
+ collection :stages, as: 'stages', class: Google::Apis::FirestoreV1beta1::Stage, decorator: Google::Apis::FirestoreV1beta1::Stage::Representation
1273
+
1274
+ end
1275
+ end
1276
+
1150
1277
  class PlanSummary
1151
1278
  # @private
1152
1279
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1254,6 +1381,17 @@ module Google
1254
1381
  end
1255
1382
  end
1256
1383
 
1384
+ class Stage
1385
+ # @private
1386
+ class Representation < Google::Apis::Core::JsonRepresentation
1387
+ collection :args, as: 'args', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
1388
+
1389
+ property :name, as: 'name'
1390
+ hash :options, as: 'options', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
1391
+
1392
+ end
1393
+ end
1394
+
1257
1395
  class Status
1258
1396
  # @private
1259
1397
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1273,6 +1411,16 @@ module Google
1273
1411
  end
1274
1412
  end
1275
1413
 
1414
+ class StructuredPipeline
1415
+ # @private
1416
+ class Representation < Google::Apis::Core::JsonRepresentation
1417
+ hash :options, as: 'options', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
1418
+
1419
+ property :pipeline, as: 'pipeline', class: Google::Apis::FirestoreV1beta1::Pipeline, decorator: Google::Apis::FirestoreV1beta1::Pipeline::Representation
1420
+
1421
+ end
1422
+ end
1423
+
1276
1424
  class StructuredQuery
1277
1425
  # @private
1278
1426
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1357,12 +1505,17 @@ module Google
1357
1505
  property :boolean_value, as: 'booleanValue'
1358
1506
  property :bytes_value, :base64 => true, as: 'bytesValue'
1359
1507
  property :double_value, as: 'doubleValue'
1508
+ property :field_reference_value, as: 'fieldReferenceValue'
1509
+ property :function_value, as: 'functionValue', class: Google::Apis::FirestoreV1beta1::Function, decorator: Google::Apis::FirestoreV1beta1::Function::Representation
1510
+
1360
1511
  property :geo_point_value, as: 'geoPointValue', class: Google::Apis::FirestoreV1beta1::LatLng, decorator: Google::Apis::FirestoreV1beta1::LatLng::Representation
1361
1512
 
1362
1513
  property :integer_value, :numeric_string => true, as: 'integerValue'
1363
1514
  property :map_value, as: 'mapValue', class: Google::Apis::FirestoreV1beta1::MapValue, decorator: Google::Apis::FirestoreV1beta1::MapValue::Representation
1364
1515
 
1365
1516
  property :null_value, as: 'nullValue'
1517
+ property :pipeline_value, as: 'pipelineValue', class: Google::Apis::FirestoreV1beta1::Pipeline, decorator: Google::Apis::FirestoreV1beta1::Pipeline::Representation
1518
+
1366
1519
  property :reference_value, as: 'referenceValue'
1367
1520
  property :string_value, as: 'stringValue'
1368
1521
  property :timestamp_value, as: 'timestampValue'
@@ -357,6 +357,40 @@ module Google
357
357
  execute_or_queue_command(command, &block)
358
358
  end
359
359
 
360
+ # Executes a pipeline query.
361
+ # @param [String] database
362
+ # Required. Database identifier, in the form `projects/`project`/databases/`
363
+ # database``.
364
+ # @param [Google::Apis::FirestoreV1beta1::ExecutePipelineRequest] execute_pipeline_request_object
365
+ # @param [String] fields
366
+ # Selector specifying which fields to include in a partial response.
367
+ # @param [String] quota_user
368
+ # Available to use for quota purposes for server-side applications. Can be any
369
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
370
+ # @param [Google::Apis::RequestOptions] options
371
+ # Request-specific options
372
+ #
373
+ # @yield [result, err] Result & error if block supplied
374
+ # @yieldparam result [Google::Apis::FirestoreV1beta1::ExecutePipelineResponse] parsed result object
375
+ # @yieldparam err [StandardError] error object if request failed
376
+ #
377
+ # @return [Google::Apis::FirestoreV1beta1::ExecutePipelineResponse]
378
+ #
379
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
380
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
381
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
382
+ def execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
383
+ command = make_simple_command(:post, 'v1beta1/{+database}/documents:executePipeline', options)
384
+ command.request_representation = Google::Apis::FirestoreV1beta1::ExecutePipelineRequest::Representation
385
+ command.request_object = execute_pipeline_request_object
386
+ command.response_representation = Google::Apis::FirestoreV1beta1::ExecutePipelineResponse::Representation
387
+ command.response_class = Google::Apis::FirestoreV1beta1::ExecutePipelineResponse
388
+ command.params['database'] = database unless database.nil?
389
+ command.query['fields'] = fields unless fields.nil?
390
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
391
+ execute_or_queue_command(command, &block)
392
+ end
393
+
360
394
  # Gets a single document.
361
395
  # @param [String] name
362
396
  # Required. The resource name of the Document to get. In the format: `projects/`
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firestore_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.47.0
4
+ version: 0.49.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.47.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.49.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
62
62
  rdoc_options: []
63
63
  require_paths:
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
73
73
  - !ruby/object:Gem::Version
74
74
  version: '0'
75
75
  requirements: []
76
- rubygems_version: 3.6.8
76
+ rubygems_version: 3.6.9
77
77
  specification_version: 4
78
78
  summary: Simple REST client for Cloud Firestore API V1beta1
79
79
  test_files: []