google-apis-firestore_v1 0.86.0 → 0.87.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:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 985a156d59c2550e3339bcbf379c2632ea6b38f0eb79e0019845845dfcca64e5
|
|
4
|
+
data.tar.gz: b94b8a1162ca9ee580c6770f3d360b121f2bd45109f16453aacb15c7ecafcd51
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 42a9c3845272b3c44e05d690e8cf20f862ad56b4c6487057455c9d65f31e3ae5d47962abe50a9ad54d434c0a18c0bbf3177a83a0f46e6828162ef98ae2cc35a8
|
|
7
|
+
data.tar.gz: add62cb646a1b0ed859314abd89645f6b0523d3ad5c191d63d20ac04112a0bcf4100be6678c514f2c9843b13e5f707e1423b0420770d9d3afa04ff317a30d41d
|
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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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
|
# A Backup of a Cloud Firestore Database. The backup contains all documents and
|
|
1160
1314
|
# index configurations for the given database at a specific point in time.
|
|
1161
1315
|
class GoogleFirestoreAdminV1Backup
|
|
@@ -1602,7 +1756,9 @@ module Google
|
|
|
1602
1756
|
# @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig]
|
|
1603
1757
|
attr_accessor :cmek_config
|
|
1604
1758
|
|
|
1605
|
-
# The concurrency control mode to use for this database.
|
|
1759
|
+
# The concurrency control mode to use for this database. If unspecified in a
|
|
1760
|
+
# CreateDatabase request, this will default based on the database edition:
|
|
1761
|
+
# Optimistic for Enterprise and Pessimistic for all other databases.
|
|
1606
1762
|
# Corresponds to the JSON property `concurrencyMode`
|
|
1607
1763
|
# @return [String]
|
|
1608
1764
|
attr_accessor :concurrency_mode
|
|
@@ -3620,6 +3776,25 @@ module Google
|
|
|
3620
3776
|
end
|
|
3621
3777
|
end
|
|
3622
3778
|
|
|
3779
|
+
# A Firestore query represented as an ordered list of operations / stages.
|
|
3780
|
+
class Pipeline
|
|
3781
|
+
include Google::Apis::Core::Hashable
|
|
3782
|
+
|
|
3783
|
+
# Required. Ordered list of stages to evaluate.
|
|
3784
|
+
# Corresponds to the JSON property `stages`
|
|
3785
|
+
# @return [Array<Google::Apis::FirestoreV1::Stage>]
|
|
3786
|
+
attr_accessor :stages
|
|
3787
|
+
|
|
3788
|
+
def initialize(**args)
|
|
3789
|
+
update!(**args)
|
|
3790
|
+
end
|
|
3791
|
+
|
|
3792
|
+
# Update properties of this object
|
|
3793
|
+
def update!(**args)
|
|
3794
|
+
@stages = args[:stages] if args.key?(:stages)
|
|
3795
|
+
end
|
|
3796
|
+
end
|
|
3797
|
+
|
|
3623
3798
|
# Planning phase information for the query.
|
|
3624
3799
|
class PlanSummary
|
|
3625
3800
|
include Google::Apis::Core::Hashable
|
|
@@ -3983,6 +4158,43 @@ module Google
|
|
|
3983
4158
|
end
|
|
3984
4159
|
end
|
|
3985
4160
|
|
|
4161
|
+
# A single operation within a pipeline. A stage is made up of a unique name, and
|
|
4162
|
+
# a list of arguments. The exact number of arguments & types is dependent on the
|
|
4163
|
+
# stage type. To give an example, the stage `filter(state = "MD")` would be
|
|
4164
|
+
# encoded as: ``` name: "filter" args ` function_value ` name: "eq" args `
|
|
4165
|
+
# field_reference_value: "state" ` args ` string_value: "MD" ` ` ` ``` See
|
|
4166
|
+
# public documentation for the full list.
|
|
4167
|
+
class Stage
|
|
4168
|
+
include Google::Apis::Core::Hashable
|
|
4169
|
+
|
|
4170
|
+
# Optional. Ordered list of arguments the given stage expects.
|
|
4171
|
+
# Corresponds to the JSON property `args`
|
|
4172
|
+
# @return [Array<Google::Apis::FirestoreV1::Value>]
|
|
4173
|
+
attr_accessor :args
|
|
4174
|
+
|
|
4175
|
+
# Required. The name of the stage to evaluate. **Requires:** * must be in snake
|
|
4176
|
+
# case (lower case with underscore separator).
|
|
4177
|
+
# Corresponds to the JSON property `name`
|
|
4178
|
+
# @return [String]
|
|
4179
|
+
attr_accessor :name
|
|
4180
|
+
|
|
4181
|
+
# Optional. Optional named arguments that certain functions may support.
|
|
4182
|
+
# Corresponds to the JSON property `options`
|
|
4183
|
+
# @return [Hash<String,Google::Apis::FirestoreV1::Value>]
|
|
4184
|
+
attr_accessor :options
|
|
4185
|
+
|
|
4186
|
+
def initialize(**args)
|
|
4187
|
+
update!(**args)
|
|
4188
|
+
end
|
|
4189
|
+
|
|
4190
|
+
# Update properties of this object
|
|
4191
|
+
def update!(**args)
|
|
4192
|
+
@args = args[:args] if args.key?(:args)
|
|
4193
|
+
@name = args[:name] if args.key?(:name)
|
|
4194
|
+
@options = args[:options] if args.key?(:options)
|
|
4195
|
+
end
|
|
4196
|
+
end
|
|
4197
|
+
|
|
3986
4198
|
# The `Status` type defines a logical error model that is suitable for different
|
|
3987
4199
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
3988
4200
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
@@ -4051,6 +4263,34 @@ module Google
|
|
|
4051
4263
|
end
|
|
4052
4264
|
end
|
|
4053
4265
|
|
|
4266
|
+
# A Firestore query represented as an ordered list of operations / stages. This
|
|
4267
|
+
# is considered the top-level function which plans and executes a query. It is
|
|
4268
|
+
# logically equivalent to `query(stages, options)`, but prevents the client from
|
|
4269
|
+
# having to build a function wrapper.
|
|
4270
|
+
class StructuredPipeline
|
|
4271
|
+
include Google::Apis::Core::Hashable
|
|
4272
|
+
|
|
4273
|
+
# Optional. Optional query-level arguments.
|
|
4274
|
+
# Corresponds to the JSON property `options`
|
|
4275
|
+
# @return [Hash<String,Google::Apis::FirestoreV1::Value>]
|
|
4276
|
+
attr_accessor :options
|
|
4277
|
+
|
|
4278
|
+
# A Firestore query represented as an ordered list of operations / stages.
|
|
4279
|
+
# Corresponds to the JSON property `pipeline`
|
|
4280
|
+
# @return [Google::Apis::FirestoreV1::Pipeline]
|
|
4281
|
+
attr_accessor :pipeline
|
|
4282
|
+
|
|
4283
|
+
def initialize(**args)
|
|
4284
|
+
update!(**args)
|
|
4285
|
+
end
|
|
4286
|
+
|
|
4287
|
+
# Update properties of this object
|
|
4288
|
+
def update!(**args)
|
|
4289
|
+
@options = args[:options] if args.key?(:options)
|
|
4290
|
+
@pipeline = args[:pipeline] if args.key?(:pipeline)
|
|
4291
|
+
end
|
|
4292
|
+
end
|
|
4293
|
+
|
|
4054
4294
|
# A Firestore query. The query stages are executed in the following order: 1.
|
|
4055
4295
|
# from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
|
|
4056
4296
|
# find_nearest
|
|
@@ -4379,6 +4619,21 @@ module Google
|
|
|
4379
4619
|
# @return [Float]
|
|
4380
4620
|
attr_accessor :double_value
|
|
4381
4621
|
|
|
4622
|
+
# Value which references a field. This is considered relative (vs absolute)
|
|
4623
|
+
# since it only refers to a field and not a field within a particular document. *
|
|
4624
|
+
# *Requires:** * Must follow field reference limitations. * Not allowed to be
|
|
4625
|
+
# used when writing documents.
|
|
4626
|
+
# Corresponds to the JSON property `fieldReferenceValue`
|
|
4627
|
+
# @return [String]
|
|
4628
|
+
attr_accessor :field_reference_value
|
|
4629
|
+
|
|
4630
|
+
# Represents an unevaluated scalar expression. For example, the expression `like(
|
|
4631
|
+
# user_name, "%alice%")` is represented as: ``` name: "like" args `
|
|
4632
|
+
# field_reference: "user_name" ` args ` string_value: "%alice%" ` ```
|
|
4633
|
+
# Corresponds to the JSON property `functionValue`
|
|
4634
|
+
# @return [Google::Apis::FirestoreV1::Function]
|
|
4635
|
+
attr_accessor :function_value
|
|
4636
|
+
|
|
4382
4637
|
# An object that represents a latitude/longitude pair. This is expressed as a
|
|
4383
4638
|
# pair of doubles to represent degrees latitude and degrees longitude. Unless
|
|
4384
4639
|
# specified otherwise, this object must conform to the WGS84 standard. Values
|
|
@@ -4402,6 +4657,11 @@ module Google
|
|
|
4402
4657
|
# @return [String]
|
|
4403
4658
|
attr_accessor :null_value
|
|
4404
4659
|
|
|
4660
|
+
# A Firestore query represented as an ordered list of operations / stages.
|
|
4661
|
+
# Corresponds to the JSON property `pipelineValue`
|
|
4662
|
+
# @return [Google::Apis::FirestoreV1::Pipeline]
|
|
4663
|
+
attr_accessor :pipeline_value
|
|
4664
|
+
|
|
4405
4665
|
# A reference to a document. For example: `projects/`project_id`/databases/`
|
|
4406
4666
|
# database_id`/documents/`document_path``.
|
|
4407
4667
|
# Corresponds to the JSON property `referenceValue`
|
|
@@ -4431,10 +4691,13 @@ module Google
|
|
|
4431
4691
|
@boolean_value = args[:boolean_value] if args.key?(:boolean_value)
|
|
4432
4692
|
@bytes_value = args[:bytes_value] if args.key?(:bytes_value)
|
|
4433
4693
|
@double_value = args[:double_value] if args.key?(:double_value)
|
|
4694
|
+
@field_reference_value = args[:field_reference_value] if args.key?(:field_reference_value)
|
|
4695
|
+
@function_value = args[:function_value] if args.key?(:function_value)
|
|
4434
4696
|
@geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value)
|
|
4435
4697
|
@integer_value = args[:integer_value] if args.key?(:integer_value)
|
|
4436
4698
|
@map_value = args[:map_value] if args.key?(:map_value)
|
|
4437
4699
|
@null_value = args[:null_value] if args.key?(:null_value)
|
|
4700
|
+
@pipeline_value = args[:pipeline_value] if args.key?(:pipeline_value)
|
|
4438
4701
|
@reference_value = args[:reference_value] if args.key?(:reference_value)
|
|
4439
4702
|
@string_value = args[:string_value] if args.key?(:string_value)
|
|
4440
4703
|
@timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value)
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module FirestoreV1
|
|
18
18
|
# Version of the google-apis-firestore_v1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.87.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 GoogleFirestoreAdminV1Backup
|
|
236
260
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
237
261
|
|
|
@@ -634,6 +658,12 @@ module Google
|
|
|
634
658
|
include Google::Apis::Core::JsonObjectSupport
|
|
635
659
|
end
|
|
636
660
|
|
|
661
|
+
class Pipeline
|
|
662
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
663
|
+
|
|
664
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
665
|
+
end
|
|
666
|
+
|
|
637
667
|
class PlanSummary
|
|
638
668
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
639
669
|
|
|
@@ -700,6 +730,12 @@ module Google
|
|
|
700
730
|
include Google::Apis::Core::JsonObjectSupport
|
|
701
731
|
end
|
|
702
732
|
|
|
733
|
+
class Stage
|
|
734
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
735
|
+
|
|
736
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
737
|
+
end
|
|
738
|
+
|
|
703
739
|
class Status
|
|
704
740
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
705
741
|
|
|
@@ -712,6 +748,12 @@ module Google
|
|
|
712
748
|
include Google::Apis::Core::JsonObjectSupport
|
|
713
749
|
end
|
|
714
750
|
|
|
751
|
+
class StructuredPipeline
|
|
752
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
753
|
+
|
|
754
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
755
|
+
end
|
|
756
|
+
|
|
715
757
|
class StructuredQuery
|
|
716
758
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
717
759
|
|
|
@@ -1009,6 +1051,30 @@ module Google
|
|
|
1009
1051
|
end
|
|
1010
1052
|
end
|
|
1011
1053
|
|
|
1054
|
+
class ExecutePipelineRequest
|
|
1055
|
+
# @private
|
|
1056
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1057
|
+
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
|
|
1058
|
+
|
|
1059
|
+
property :read_time, as: 'readTime'
|
|
1060
|
+
property :structured_pipeline, as: 'structuredPipeline', class: Google::Apis::FirestoreV1::StructuredPipeline, decorator: Google::Apis::FirestoreV1::StructuredPipeline::Representation
|
|
1061
|
+
|
|
1062
|
+
property :transaction, :base64 => true, as: 'transaction'
|
|
1063
|
+
end
|
|
1064
|
+
end
|
|
1065
|
+
|
|
1066
|
+
class ExecutePipelineResponse
|
|
1067
|
+
# @private
|
|
1068
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1069
|
+
property :execution_time, as: 'executionTime'
|
|
1070
|
+
property :explain_stats, as: 'explainStats', class: Google::Apis::FirestoreV1::ExplainStats, decorator: Google::Apis::FirestoreV1::ExplainStats::Representation
|
|
1071
|
+
|
|
1072
|
+
collection :results, as: 'results', class: Google::Apis::FirestoreV1::Document, decorator: Google::Apis::FirestoreV1::Document::Representation
|
|
1073
|
+
|
|
1074
|
+
property :transaction, :base64 => true, as: 'transaction'
|
|
1075
|
+
end
|
|
1076
|
+
end
|
|
1077
|
+
|
|
1012
1078
|
class ExecutionStats
|
|
1013
1079
|
# @private
|
|
1014
1080
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1046,6 +1112,13 @@ module Google
|
|
|
1046
1112
|
end
|
|
1047
1113
|
end
|
|
1048
1114
|
|
|
1115
|
+
class ExplainStats
|
|
1116
|
+
# @private
|
|
1117
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1118
|
+
hash :data, as: 'data'
|
|
1119
|
+
end
|
|
1120
|
+
end
|
|
1121
|
+
|
|
1049
1122
|
class FieldFilter
|
|
1050
1123
|
# @private
|
|
1051
1124
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1108,6 +1181,17 @@ module Google
|
|
|
1108
1181
|
end
|
|
1109
1182
|
end
|
|
1110
1183
|
|
|
1184
|
+
class Function
|
|
1185
|
+
# @private
|
|
1186
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1187
|
+
collection :args, as: 'args', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
|
|
1188
|
+
|
|
1189
|
+
property :name, as: 'name'
|
|
1190
|
+
hash :options, as: 'options', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
|
|
1191
|
+
|
|
1192
|
+
end
|
|
1193
|
+
end
|
|
1194
|
+
|
|
1111
1195
|
class GoogleFirestoreAdminV1Backup
|
|
1112
1196
|
# @private
|
|
1113
1197
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1774,6 +1858,14 @@ module Google
|
|
|
1774
1858
|
end
|
|
1775
1859
|
end
|
|
1776
1860
|
|
|
1861
|
+
class Pipeline
|
|
1862
|
+
# @private
|
|
1863
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1864
|
+
collection :stages, as: 'stages', class: Google::Apis::FirestoreV1::Stage, decorator: Google::Apis::FirestoreV1::Stage::Representation
|
|
1865
|
+
|
|
1866
|
+
end
|
|
1867
|
+
end
|
|
1868
|
+
|
|
1777
1869
|
class PlanSummary
|
|
1778
1870
|
# @private
|
|
1779
1871
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1881,6 +1973,17 @@ module Google
|
|
|
1881
1973
|
end
|
|
1882
1974
|
end
|
|
1883
1975
|
|
|
1976
|
+
class Stage
|
|
1977
|
+
# @private
|
|
1978
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1979
|
+
collection :args, as: 'args', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
|
|
1980
|
+
|
|
1981
|
+
property :name, as: 'name'
|
|
1982
|
+
hash :options, as: 'options', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
|
|
1983
|
+
|
|
1984
|
+
end
|
|
1985
|
+
end
|
|
1986
|
+
|
|
1884
1987
|
class Status
|
|
1885
1988
|
# @private
|
|
1886
1989
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1900,6 +2003,16 @@ module Google
|
|
|
1900
2003
|
end
|
|
1901
2004
|
end
|
|
1902
2005
|
|
|
2006
|
+
class StructuredPipeline
|
|
2007
|
+
# @private
|
|
2008
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
2009
|
+
hash :options, as: 'options', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
|
|
2010
|
+
|
|
2011
|
+
property :pipeline, as: 'pipeline', class: Google::Apis::FirestoreV1::Pipeline, decorator: Google::Apis::FirestoreV1::Pipeline::Representation
|
|
2012
|
+
|
|
2013
|
+
end
|
|
2014
|
+
end
|
|
2015
|
+
|
|
1903
2016
|
class StructuredQuery
|
|
1904
2017
|
# @private
|
|
1905
2018
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
@@ -1984,12 +2097,17 @@ module Google
|
|
|
1984
2097
|
property :boolean_value, as: 'booleanValue'
|
|
1985
2098
|
property :bytes_value, :base64 => true, as: 'bytesValue'
|
|
1986
2099
|
property :double_value, as: 'doubleValue'
|
|
2100
|
+
property :field_reference_value, as: 'fieldReferenceValue'
|
|
2101
|
+
property :function_value, as: 'functionValue', class: Google::Apis::FirestoreV1::Function, decorator: Google::Apis::FirestoreV1::Function::Representation
|
|
2102
|
+
|
|
1987
2103
|
property :geo_point_value, as: 'geoPointValue', class: Google::Apis::FirestoreV1::LatLng, decorator: Google::Apis::FirestoreV1::LatLng::Representation
|
|
1988
2104
|
|
|
1989
2105
|
property :integer_value, :numeric_string => true, as: 'integerValue'
|
|
1990
2106
|
property :map_value, as: 'mapValue', class: Google::Apis::FirestoreV1::MapValue, decorator: Google::Apis::FirestoreV1::MapValue::Representation
|
|
1991
2107
|
|
|
1992
2108
|
property :null_value, as: 'nullValue'
|
|
2109
|
+
property :pipeline_value, as: 'pipelineValue', class: Google::Apis::FirestoreV1::Pipeline, decorator: Google::Apis::FirestoreV1::Pipeline::Representation
|
|
2110
|
+
|
|
1993
2111
|
property :reference_value, as: 'referenceValue'
|
|
1994
2112
|
property :string_value, as: 'stringValue'
|
|
1995
2113
|
property :timestamp_value, as: 'timestampValue'
|
|
@@ -1100,6 +1100,40 @@ module Google
|
|
|
1100
1100
|
execute_or_queue_command(command, &block)
|
|
1101
1101
|
end
|
|
1102
1102
|
|
|
1103
|
+
# Executes a pipeline query.
|
|
1104
|
+
# @param [String] database
|
|
1105
|
+
# Required. Database identifier, in the form `projects/`project`/databases/`
|
|
1106
|
+
# database``.
|
|
1107
|
+
# @param [Google::Apis::FirestoreV1::ExecutePipelineRequest] execute_pipeline_request_object
|
|
1108
|
+
# @param [String] fields
|
|
1109
|
+
# Selector specifying which fields to include in a partial response.
|
|
1110
|
+
# @param [String] quota_user
|
|
1111
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1112
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1113
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1114
|
+
# Request-specific options
|
|
1115
|
+
#
|
|
1116
|
+
# @yield [result, err] Result & error if block supplied
|
|
1117
|
+
# @yieldparam result [Google::Apis::FirestoreV1::ExecutePipelineResponse] parsed result object
|
|
1118
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1119
|
+
#
|
|
1120
|
+
# @return [Google::Apis::FirestoreV1::ExecutePipelineResponse]
|
|
1121
|
+
#
|
|
1122
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1123
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1124
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1125
|
+
def execute_document_pipeline(database, execute_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1126
|
+
command = make_simple_command(:post, 'v1/{+database}/documents:executePipeline', options)
|
|
1127
|
+
command.request_representation = Google::Apis::FirestoreV1::ExecutePipelineRequest::Representation
|
|
1128
|
+
command.request_object = execute_pipeline_request_object
|
|
1129
|
+
command.response_representation = Google::Apis::FirestoreV1::ExecutePipelineResponse::Representation
|
|
1130
|
+
command.response_class = Google::Apis::FirestoreV1::ExecutePipelineResponse
|
|
1131
|
+
command.params['database'] = database unless database.nil?
|
|
1132
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1133
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1134
|
+
execute_or_queue_command(command, &block)
|
|
1135
|
+
end
|
|
1136
|
+
|
|
1103
1137
|
# Gets a single document.
|
|
1104
1138
|
# @param [String] name
|
|
1105
1139
|
# 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_v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.87.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_v1/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.87.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|