feat: Generate Google.Apis.Firestore.v1 version 1.73.0.4002

Author: amanda-tarafa

DiscoveryJson/firestore.v1.json

@@ -1464,6 +1464,35 @@
                     "https://www.googleapis.com/auth/datastore"
                   ]
                 },
+                "executePipeline": {
+                  "description": "Executes a pipeline query.",
+                  "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:executePipeline",
+                  "httpMethod": "POST",
+                  "id": "firestore.projects.databases.documents.executePipeline",
+                  "parameterOrder": [
+                    "database"
+                  ],
+                  "parameters": {
+                    "database": {
+                      "description": "Required. Database identifier, in the form `projects/{project}/databases/{database}`.",
+                      "location": "path",
+                      "pattern": "^projects/[^/]+/databases/[^/]+$",
+                      "required": true,
+                      "type": "string"
+                    }
+                  },
+                  "path": "v1/{+database}/documents:executePipeline",
+                  "request": {
+                    "$ref": "ExecutePipelineRequest"
+                  },
+                  "response": {
+                    "$ref": "ExecutePipelineResponse"
+                  },
+                  "scopes": [
+                    "https://www.googleapis.com/auth/cloud-platform",
+                    "https://www.googleapis.com/auth/datastore"
+                  ]
+                },
                 "get": {
                   "description": "Gets a single document.",
                   "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
@@ -2416,7 +2445,7 @@
       }
     }
   },
-  "revision": "20251203",
+  "revision": "20251216",
   "rootUrl": "https://firestore.googleapis.com/",
   "schemas": {
     "Aggregation": {
@@ -2902,6 +2931,59 @@
       "properties": {},
       "type": "object"
     },
+    "ExecutePipelineRequest": {
+      "description": "The request for Firestore.ExecutePipeline.",
+      "id": "ExecutePipelineRequest",
+      "properties": {
+        "newTransaction": {
+          "$ref": "TransactionOptions",
+          "description": "Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction."
+        },
+        "readTime": {
+          "description": "Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.",
+          "format": "google-datetime",
+          "type": "string"
+        },
+        "structuredPipeline": {
+          "$ref": "StructuredPipeline",
+          "description": "A pipelined operation."
+        },
+        "transaction": {
+          "description": "Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.",
+          "format": "byte",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "ExecutePipelineResponse": {
+      "description": "The response for Firestore.Execute.",
+      "id": "ExecutePipelineResponse",
+      "properties": {
+        "executionTime": {
+          "description": "The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest `execution_time`. This allows the API consumer to treat the query if it ran at the latest `execution_time` returned. If the query returns no results, a response with `execution_time` and no `results` will be sent, and this represents the time at which the operation was run.",
+          "format": "google-datetime",
+          "type": "string"
+        },
+        "explainStats": {
+          "$ref": "ExplainStats",
+          "description": "Query explain stats. This is present on the **last** response if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with `explain_stats` and no `results` will still be sent."
+        },
+        "results": {
+          "description": "An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like `__name__` and `__update_time__`. This is explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even when they are not specified in the `mask`.",
+          "items": {
+            "$ref": "Document"
+          },
+          "type": "array"
+        },
+        "transaction": {
+          "description": "Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the `results` field when the original request specified ExecuteRequest.new_transaction.",
+          "format": "byte",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "ExecutionStats": {
       "description": "Execution statistics for the query.",
       "id": "ExecutionStats",
@@ -2979,6 +3061,21 @@
       },
       "type": "object"
     },
+    "ExplainStats": {
+      "description": "Pipeline explain stats. Depending on the explain options in the original request, this can contain the optimized plan and / or execution stats.",
+      "id": "ExplainStats",
+      "properties": {
+        "data": {
+          "additionalProperties": {
+            "description": "Properties of the object. Contains field @type with type URL.",
+            "type": "any"
+          },
+          "description": "The format depends on the `output_format` options in the request. Currently there are two supported options: `TEXT` and `JSON`. Both supply a `google.protobuf.StringValue`.",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
     "FieldFilter": {
       "description": "A filter on a specific field.",
       "id": "FieldFilter",
@@ -3142,6 +3239,31 @@
       },
       "type": "object"
     },
+    "Function": {
+      "description": "Represents an unevaluated scalar expression. For example, the expression `like(user_name, \"%alice%\")` is represented as: ``` name: \"like\" args { field_reference: \"user_name\" } args { string_value: \"%alice%\" } ```",
+      "id": "Function",
+      "properties": {
+        "args": {
+          "description": "Optional. Ordered list of arguments the given function expects.",
+          "items": {
+            "$ref": "Value"
+          },
+          "type": "array"
+        },
+        "name": {
+          "description": "Required. The name of the function to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).",
+          "type": "string"
+        },
+        "options": {
+          "additionalProperties": {
+            "$ref": "Value"
+          },
+          "description": "Optional. Optional named arguments that certain functions may support.",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
     "GoogleFirestoreAdminV1Backup": {
       "description": "A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.",
       "id": "GoogleFirestoreAdminV1Backup",
@@ -3479,7 +3601,7 @@
           "description": "Optional. Presence indicates CMEK is enabled for this database."
         },
         "concurrencyMode": {
-          "description": "The concurrency control mode to use for this database.",
+          "description": "The concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases.",
           "enum": [
             "CONCURRENCY_MODE_UNSPECIFIED",
             "OPTIMISTIC",
@@ -3488,9 +3610,9 @@
           ],
           "enumDescriptions": [
             "Not used.",
-            "Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.",
-            "Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.",
-            "Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended."
+            "Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Enterprise Edition databases.",
+            "Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Standard Edition databases.",
+            "Use optimistic concurrency control with entity groups by default. This mode is enabled for some databases that were automatically upgraded from Cloud Datastore to Cloud Firestore with Datastore Mode. It is not recommended for any new databases, and not supported for Firestore Native databases."
           ],
           "type": "string"
         },
@@ -5012,6 +5134,20 @@
       },
       "type": "object"
     },
+    "Pipeline": {
+      "description": "A Firestore query represented as an ordered list of operations / stages.",
+      "id": "Pipeline",
+      "properties": {
+        "stages": {
+          "description": "Required. Ordered list of stages to evaluate.",
+          "items": {
+            "$ref": "Stage"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "PlanSummary": {
       "description": "Planning phase information for the query.",
       "id": "PlanSummary",
@@ -5228,6 +5364,31 @@
       },
       "type": "object"
     },
+    "Stage": {
+      "description": "A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact number of arguments & types is dependent on the stage type. To give an example, the stage `filter(state = \"MD\")` would be encoded as: ``` name: \"filter\" args { function_value { name: \"eq\" args { field_reference_value: \"state\" } args { string_value: \"MD\" } } } ``` See public documentation for the full list.",
+      "id": "Stage",
+      "properties": {
+        "args": {
+          "description": "Optional. Ordered list of arguments the given stage expects.",
+          "items": {
+            "$ref": "Value"
+          },
+          "type": "array"
+        },
+        "name": {
+          "description": "Required. The name of the stage to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).",
+          "type": "string"
+        },
+        "options": {
+          "additionalProperties": {
+            "$ref": "Value"
+          },
+          "description": "Optional. Optional named arguments that certain functions may support.",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
     "Status": {
       "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
       "id": "Status",
@@ -5273,6 +5434,24 @@
       },
       "type": "object"
     },
+    "StructuredPipeline": {
+      "description": "A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper.",
+      "id": "StructuredPipeline",
+      "properties": {
+        "options": {
+          "additionalProperties": {
+            "$ref": "Value"
+          },
+          "description": "Optional. Optional query-level arguments. ",
+          "type": "object"
+        },
+        "pipeline": {
+          "$ref": "Pipeline",
+          "description": "Required. The pipeline query to execute."
+        }
+      },
+      "type": "object"
+    },
     "StructuredQuery": {
       "description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest",
       "id": "StructuredQuery",
@@ -5487,6 +5666,14 @@
           "format": "double",
           "type": "number"
         },
+        "fieldReferenceValue": {
+          "description": "Value which references a field. This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document. **Requires:** * Must follow field reference limitations. * Not allowed to be used when writing documents.",
+          "type": "string"
+        },
+        "functionValue": {
+          "$ref": "Function",
+          "description": "A value that represents an unevaluated expression. **Requires:** * Not allowed to be used when writing documents."
+        },
         "geoPointValue": {
           "$ref": "LatLng",
           "description": "A geo point value representing a point on the surface of Earth."
@@ -5510,6 +5697,10 @@
           ],
           "type": "string"
         },
+        "pipelineValue": {
+          "$ref": "Pipeline",
+          "description": "A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents."
+        },
         "referenceValue": {
           "description": "A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
           "type": "string"