feat(datastore): update the api

#### datastore:v1 The following keys were added: - schemas.ExecutionStats (Total Keys: 10) - schemas.ExplainMetrics (Total Keys: 4) - schemas.ExplainOptions (Total Keys: 3) - schemas.LookupRequest.properties.propertyMask.$ref (Total Keys: 1) - schemas.Mutation.properties.propertyMask.$ref (Total Keys: 1) - schemas.PlanSummary (Total Keys: 5) - schemas.PropertyMask (Total Keys: 4) - schemas.RunAggregationQueryRequest.properties.explainOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryResponse.properties.explainMetrics.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.explainOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.propertyMask.$ref (Total Keys: 1) - schemas.RunQueryResponse.properties.explainMetrics.$ref (Total Keys: 1) #### datastore:v1beta3 The following keys were added: - schemas.ExecutionStats (Total Keys: 10) - schemas.ExplainMetrics (Total Keys: 4) - schemas.ExplainOptions (Total Keys: 3) - schemas.LookupRequest.properties.propertyMask.$ref (Total Keys: 1) - schemas.Mutation.properties.propertyMask.$ref (Total Keys: 1) - schemas.PlanSummary (Total Keys: 5) - schemas.PropertyMask (Total Keys: 4) - schemas.RunAggregationQueryRequest.properties.explainOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryResponse.properties.explainMetrics.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.explainOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.propertyMask.$ref (Total Keys: 1) - schemas.RunQueryResponse.properties.explainMetrics.$ref (Total Keys: 1)
googleapis · Mar 26, 2024 · c889631 · c889631
1 parent d65b377
commit c889631
Show file tree

Hide file tree

Showing 5 changed files with 345 additions and 3 deletions.
diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html
@@ -296,6 +296,11 @@ <h3>Method Details</h3>
           },
         },
       },
+      &quot;propertyMask&quot;: { # The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity. # The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted.
+        &quot;paths&quot;: [ # The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value.
+          &quot;A String&quot;,
+        ],
+      },
       &quot;update&quot;: { # A Datastore data object. Must not exceed 1 MiB - 4 bytes. # The entity to update. The entity must already exist. Must have a complete key path.
         &quot;key&quot;: { # A unique identifier for an entity. If a key&#x27;s partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity&#x27;s key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity&#x27;s kind is its key path&#x27;s last element&#x27;s kind, or null if it has no key.
           &quot;partitionId&quot;: { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `&quot;&quot;`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
@@ -585,6 +590,11 @@ <h3>Method Details</h3>
       ],
     },
   ],
+  &quot;propertyMask&quot;: { # The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity. # The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity&#x27;s key is always returned.
+    &quot;paths&quot;: [ # The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value.
+      &quot;A String&quot;,
+    ],
+  },
   &quot;readOptions&quot;: { # The options shared by read requests. # The options for this lookup request.
     &quot;newTransaction&quot;: { # Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. # Options for beginning a new transaction for this request. The new transaction identifier will be returned in the corresponding response as either LookupResponse.transaction or RunQueryResponse.transaction.
       &quot;readOnly&quot;: { # Options specific to read-only transactions. # The transaction should only allow reads.
@@ -930,6 +940,9 @@ <h3>Method Details</h3>
     },
   },
   &quot;databaseId&quot;: &quot;A String&quot;, # The ID of the database against which to make the request. &#x27;(default)&#x27; is not allowed; please use empty string &#x27;&#x27; to refer the default database.
+  &quot;explainOptions&quot;: { # Explain options for the query. # Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
+    &quot;analyze&quot;: True or False, # Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
+  },
   &quot;gqlQuery&quot;: { # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # The GQL query to run. This query must be an aggregation query.
     &quot;allowLiterals&quot;: True or False, # When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = &#x27;string literal&#x27;` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is.
     &quot;namedBindings&quot;: { # For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `&quot;&quot;`.
@@ -1088,6 +1101,23 @@ <h3>Method Details</h3>
     &quot;moreResults&quot;: &quot;A String&quot;, # The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to `NO_MORE_RESULTS`.
     &quot;readTime&quot;: &quot;A String&quot;, # Read timestamp this batch was returned from. In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch&#x27;s read timestamp is valid for all preceding batches.
   },
+  &quot;explainMetrics&quot;: { # Explain metrics for the query. # Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
+    &quot;executionStats&quot;: { # Execution statistics for the query. # Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.
+      &quot;debugStats&quot;: { # Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { &quot;indexes_entries_scanned&quot;: &quot;1000&quot;, &quot;documents_scanned&quot;: &quot;20&quot;, &quot;billing_details&quot; : { &quot;documents_billable&quot;: &quot;20&quot;, &quot;index_entries_billable&quot;: &quot;1000&quot;, &quot;min_query_cost&quot;: &quot;0&quot; } }
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+      },
+      &quot;executionDuration&quot;: &quot;A String&quot;, # Total time to execute the query in the backend.
+      &quot;readOperations&quot;: &quot;A String&quot;, # Total billable read operations.
+      &quot;resultsReturned&quot;: &quot;A String&quot;, # Total number of results returned, including documents, projections, aggregation results, keys.
+    },
+    &quot;planSummary&quot;: { # Planning phase information for the query. # Planning phase information for the query.
+      &quot;indexesUsed&quot;: [ # The indexes selected for the query. For example: [ {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(foo ASC, __name__ ASC)&quot;}, {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(bar ASC, __name__ ASC)&quot;} ]
+        {
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+      ],
+    },
+  },
   &quot;query&quot;: { # Datastore query for running an aggregation over a Query. # The parsed form of the `GqlQuery` from the request, if it was set.
     &quot;aggregations&quot;: [ # Optional. Series of aggregations to apply over the results of the `nested_query`. Requires: * A minimum of one and maximum of five aggregations per query.
       { # Defines an aggregation that produces a single result.
@@ -1203,6 +1233,9 @@ <h3>Method Details</h3>
 
 { # The request for Datastore.RunQuery.
   &quot;databaseId&quot;: &quot;A String&quot;, # The ID of the database against which to make the request. &#x27;(default)&#x27; is not allowed; please use empty string &#x27;&#x27; to refer the default database.
+  &quot;explainOptions&quot;: { # Explain options for the query. # Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
+    &quot;analyze&quot;: True or False, # Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
+  },
   &quot;gqlQuery&quot;: { # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # The GQL query to run. This query must be a non-aggregation query.
     &quot;allowLiterals&quot;: True or False, # When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = &#x27;string literal&#x27;` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is.
     &quot;namedBindings&quot;: { # For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `&quot;&quot;`.
@@ -1292,6 +1325,11 @@ <h3>Method Details</h3>
     &quot;namespaceId&quot;: &quot;A String&quot;, # If not empty, the ID of the namespace to which the entities belong.
     &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project to which the entities belong.
   },
+  &quot;propertyMask&quot;: { # The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity. # The properties to return. This field must not be set for a projection query. See LookupRequest.property_mask.
+    &quot;paths&quot;: [ # The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value.
+      &quot;A String&quot;,
+    ],
+  },
   &quot;query&quot;: { # A query for entities. # The query to run.
     &quot;distinctOn&quot;: [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
       { # A reference to a property relative to the kind expressions.
@@ -1466,6 +1504,23 @@ <h3>Method Details</h3>
     &quot;skippedResults&quot;: 42, # The number of results skipped, typically because of an offset.
     &quot;snapshotVersion&quot;: &quot;A String&quot;, # The version number of the snapshot this batch was returned from. This applies to the range of results from the query&#x27;s `start_cursor` (or the beginning of the query if no cursor was given) to this batch&#x27;s `end_cursor` (not the query&#x27;s `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch&#x27;s snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.
   },
+  &quot;explainMetrics&quot;: { # Explain metrics for the query. # Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
+    &quot;executionStats&quot;: { # Execution statistics for the query. # Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.
+      &quot;debugStats&quot;: { # Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { &quot;indexes_entries_scanned&quot;: &quot;1000&quot;, &quot;documents_scanned&quot;: &quot;20&quot;, &quot;billing_details&quot; : { &quot;documents_billable&quot;: &quot;20&quot;, &quot;index_entries_billable&quot;: &quot;1000&quot;, &quot;min_query_cost&quot;: &quot;0&quot; } }
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+      },
+      &quot;executionDuration&quot;: &quot;A String&quot;, # Total time to execute the query in the backend.
+      &quot;readOperations&quot;: &quot;A String&quot;, # Total billable read operations.
+      &quot;resultsReturned&quot;: &quot;A String&quot;, # Total number of results returned, including documents, projections, aggregation results, keys.
+    },
+    &quot;planSummary&quot;: { # Planning phase information for the query. # Planning phase information for the query.
+      &quot;indexesUsed&quot;: [ # The indexes selected for the query. For example: [ {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(foo ASC, __name__ ASC)&quot;}, {&quot;query_scope&quot;: &quot;Collection&quot;, &quot;properties&quot;: &quot;(bar ASC, __name__ ASC)&quot;} ]
+        {
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+      ],
+    },
+  },
   &quot;query&quot;: { # A query for entities. # The parsed form of the `GqlQuery` from the request, if it was set.
     &quot;distinctOn&quot;: [ # The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
       { # A reference to a property relative to the kind expressions.