google-apis-firestore_v1beta1 0.48.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 +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/firestore_v1beta1/classes.rb +261 -0
- data/lib/google/apis/firestore_v1beta1/gem_version.rb +2 -2
- data/lib/google/apis/firestore_v1beta1/representations.rb +118 -0
- data/lib/google/apis/firestore_v1beta1/service.rb +34 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d0a662620bde5df867d729a2fb6de140b74ef18fb93b0be016c83631b9b59c50
|
|
4
|
+
data.tar.gz: ccce7ddf4863168a063377f584ac60a55ef587de165672a698e15c4e03c65a1d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ad7981418af0fb604b89771ca5059537101d807f5905fffc94a208df998f5236f811ae9f2c788860c9b392aeef9bf4c7daa6baaac48cf1ffe31b7c492dcd61ec
|
|
7
|
+
data.tar.gz: 3982374241697226de7578b1e1eae43aaf4ae08cbeb5987f8fca02de3f9a834e69139ab48b09faadf089b7dda10cb5bd0d594fdabf7ee57931c1f40e54fc39d6
|
data/CHANGELOG.md
CHANGED
|
@@ -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
|
|
@@ -2211,6 +2365,25 @@ module Google
|
|
|
2211
2365
|
end
|
|
2212
2366
|
end
|
|
2213
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
|
+
|
|
2214
2387
|
# Planning phase information for the query.
|
|
2215
2388
|
class PlanSummary
|
|
2216
2389
|
include Google::Apis::Core::Hashable
|
|
@@ -2574,6 +2747,43 @@ module Google
|
|
|
2574
2747
|
end
|
|
2575
2748
|
end
|
|
2576
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
|
+
|
|
2577
2787
|
# The `Status` type defines a logical error model that is suitable for different
|
|
2578
2788
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
2579
2789
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
@@ -2642,6 +2852,34 @@ module Google
|
|
|
2642
2852
|
end
|
|
2643
2853
|
end
|
|
2644
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
|
+
|
|
2645
2883
|
# A Firestore query. The query stages are executed in the following order: 1.
|
|
2646
2884
|
# from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
|
|
2647
2885
|
# find_nearest
|
|
@@ -2970,6 +3208,21 @@ module Google
|
|
|
2970
3208
|
# @return [Float]
|
|
2971
3209
|
attr_accessor :double_value
|
|
2972
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
|
+
|
|
2973
3226
|
# An object that represents a latitude/longitude pair. This is expressed as a
|
|
2974
3227
|
# pair of doubles to represent degrees latitude and degrees longitude. Unless
|
|
2975
3228
|
# specified otherwise, this object must conform to the WGS84 standard. Values
|
|
@@ -2993,6 +3246,11 @@ module Google
|
|
|
2993
3246
|
# @return [String]
|
|
2994
3247
|
attr_accessor :null_value
|
|
2995
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
|
+
|
|
2996
3254
|
# A reference to a document. For example: `projects/`project_id`/databases/`
|
|
2997
3255
|
# database_id`/documents/`document_path``.
|
|
2998
3256
|
# Corresponds to the JSON property `referenceValue`
|
|
@@ -3022,10 +3280,13 @@ module Google
|
|
|
3022
3280
|
@boolean_value = args[:boolean_value] if args.key?(:boolean_value)
|
|
3023
3281
|
@bytes_value = args[:bytes_value] if args.key?(:bytes_value)
|
|
3024
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)
|
|
3025
3285
|
@geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value)
|
|
3026
3286
|
@integer_value = args[:integer_value] if args.key?(:integer_value)
|
|
3027
3287
|
@map_value = args[:map_value] if args.key?(:map_value)
|
|
3028
3288
|
@null_value = args[:null_value] if args.key?(:null_value)
|
|
3289
|
+
@pipeline_value = args[:pipeline_value] if args.key?(:pipeline_value)
|
|
3029
3290
|
@reference_value = args[:reference_value] if args.key?(:reference_value)
|
|
3030
3291
|
@string_value = args[:string_value] if args.key?(:string_value)
|
|
3031
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.
|
|
19
|
+
GEM_VERSION = "0.49.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.18.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
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,6 +250,12 @@ 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
|
|
|
@@ -412,6 +436,12 @@ module Google
|
|
|
412
436
|
include Google::Apis::Core::JsonObjectSupport
|
|
413
437
|
end
|
|
414
438
|
|
|
439
|
+
class Pipeline
|
|
440
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
441
|
+
|
|
442
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
443
|
+
end
|
|
444
|
+
|
|
415
445
|
class PlanSummary
|
|
416
446
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
417
447
|
|
|
@@ -478,6 +508,12 @@ module Google
|
|
|
478
508
|
include Google::Apis::Core::JsonObjectSupport
|
|
479
509
|
end
|
|
480
510
|
|
|
511
|
+
class Stage
|
|
512
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
513
|
+
|
|
514
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
515
|
+
end
|
|
516
|
+
|
|
481
517
|
class Status
|
|
482
518
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
483
519
|
|
|
@@ -490,6 +526,12 @@ module Google
|
|
|
490
526
|
include Google::Apis::Core::JsonObjectSupport
|
|
491
527
|
end
|
|
492
528
|
|
|
529
|
+
class StructuredPipeline
|
|
530
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
531
|
+
|
|
532
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
533
|
+
end
|
|
534
|
+
|
|
493
535
|
class StructuredQuery
|
|
494
536
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
495
537
|
|
|
@@ -787,6 +829,30 @@ module Google
|
|
|
787
829
|
end
|
|
788
830
|
end
|
|
789
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
|
+
|
|
790
856
|
class ExecutionStats
|
|
791
857
|
# @private
|
|
792
858
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -824,6 +890,13 @@ module Google
|
|
|
824
890
|
end
|
|
825
891
|
end
|
|
826
892
|
|
|
893
|
+
class ExplainStats
|
|
894
|
+
# @private
|
|
895
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
896
|
+
hash :data, as: 'data'
|
|
897
|
+
end
|
|
898
|
+
end
|
|
899
|
+
|
|
827
900
|
class FieldFilter
|
|
828
901
|
# @private
|
|
829
902
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -886,6 +959,17 @@ module Google
|
|
|
886
959
|
end
|
|
887
960
|
end
|
|
888
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
|
+
|
|
889
973
|
class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
|
|
890
974
|
# @private
|
|
891
975
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1182,6 +1266,14 @@ module Google
|
|
|
1182
1266
|
end
|
|
1183
1267
|
end
|
|
1184
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
|
+
|
|
1185
1277
|
class PlanSummary
|
|
1186
1278
|
# @private
|
|
1187
1279
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1289,6 +1381,17 @@ module Google
|
|
|
1289
1381
|
end
|
|
1290
1382
|
end
|
|
1291
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
|
+
|
|
1292
1395
|
class Status
|
|
1293
1396
|
# @private
|
|
1294
1397
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1308,6 +1411,16 @@ module Google
|
|
|
1308
1411
|
end
|
|
1309
1412
|
end
|
|
1310
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
|
+
|
|
1311
1424
|
class StructuredQuery
|
|
1312
1425
|
# @private
|
|
1313
1426
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1392,12 +1505,17 @@ module Google
|
|
|
1392
1505
|
property :boolean_value, as: 'booleanValue'
|
|
1393
1506
|
property :bytes_value, :base64 => true, as: 'bytesValue'
|
|
1394
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
|
+
|
|
1395
1511
|
property :geo_point_value, as: 'geoPointValue', class: Google::Apis::FirestoreV1beta1::LatLng, decorator: Google::Apis::FirestoreV1beta1::LatLng::Representation
|
|
1396
1512
|
|
|
1397
1513
|
property :integer_value, :numeric_string => true, as: 'integerValue'
|
|
1398
1514
|
property :map_value, as: 'mapValue', class: Google::Apis::FirestoreV1beta1::MapValue, decorator: Google::Apis::FirestoreV1beta1::MapValue::Representation
|
|
1399
1515
|
|
|
1400
1516
|
property :null_value, as: 'nullValue'
|
|
1517
|
+
property :pipeline_value, as: 'pipelineValue', class: Google::Apis::FirestoreV1beta1::Pipeline, decorator: Google::Apis::FirestoreV1beta1::Pipeline::Representation
|
|
1518
|
+
|
|
1401
1519
|
property :reference_value, as: 'referenceValue'
|
|
1402
1520
|
property :string_value, as: 'stringValue'
|
|
1403
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.
|
|
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.
|
|
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:
|