Skip to content

Commit de7c0c9

Browse files
feat(firestore): update the api
#### firestore:v1 The following keys were added: - schemas.GoogleFirestoreAdminV1ExportDocumentsMetadata.properties.snapshotTime (Total Keys: 2)
1 parent aa39136 commit de7c0c9

File tree

5 files changed

+50
-45
lines changed

5 files changed

+50
-45
lines changed

docs/dyn/firestore_v1.projects.databases.documents.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -161,13 +161,13 @@ <h3>Method Details</h3>
161161
},
162162
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
163163
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
164-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
164+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents 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.
165165
},
166166
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
167167
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
168168
},
169169
},
170-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were at the given time. This may not be older than 270 seconds.
170+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were 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.
171171
&quot;transaction&quot;: &quot;A String&quot;, # Reads documents in a transaction.
172172
}
173173

@@ -522,7 +522,7 @@ <h3>Method Details</h3>
522522
{ # The request for Firestore.BeginTransaction.
523523
&quot;options&quot;: { # Options for creating a new transaction. # The options for the transaction. Defaults to a read-write transaction.
524524
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
525-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
525+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents 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.
526526
},
527527
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
528528
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
@@ -941,7 +941,7 @@ <h3>Method Details</h3>
941941
Args:
942942
name: string, Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
943943
mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated)
944-
readTime: string, Reads the version of the document at the given time. This may not be older than 270 seconds.
944+
readTime: string, Reads the version of the document 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.
945945
transaction: string, Reads the document in a transaction.
946946
x__xgafv: string, V1 error format.
947947
Allowed values
@@ -995,7 +995,7 @@ <h3>Method Details</h3>
995995
orderBy: string, Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`.
996996
pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
997997
pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token.
998-
readTime: string, Perform the read at the provided time. This may not be older than 270 seconds.
998+
readTime: string, Perform the read at the provided 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.
999999
showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.
10001000
transaction: string, Perform the read as part of an already active transaction.
10011001
x__xgafv: string, V1 error format.
@@ -1056,7 +1056,7 @@ <h3>Method Details</h3>
10561056
{ # The request for Firestore.ListCollectionIds.
10571057
&quot;pageSize&quot;: 42, # The maximum number of results to return.
10581058
&quot;pageToken&quot;: &quot;A String&quot;, # A page token. Must be a value from ListCollectionIdsResponse.
1059-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were at the given time. This may not be older than 270 seconds.
1059+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were 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.
10601060
}
10611061

10621062
x__xgafv: string, V1 error format.
@@ -1100,7 +1100,7 @@ <h3>Method Details</h3>
11001100
orderBy: string, Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`.
11011101
pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
11021102
pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token.
1103-
readTime: string, Perform the read at the provided time. This may not be older than 270 seconds.
1103+
readTime: string, Perform the read at the provided 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.
11041104
showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.
11051105
transaction: string, Perform the read as part of an already active transaction.
11061106
x__xgafv: string, V1 error format.
@@ -1441,7 +1441,7 @@ <h3>Method Details</h3>
14411441
&quot;pageSize&quot;: 42, # The maximum number of partitions to return in this call, subject to `partition_count`. For example, if `partition_count` = 10 and `page_size` = 8, the first call to PartitionQuery will return up to 8 partitions and a `next_page_token` if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in `partition_count`.
14421442
&quot;pageToken&quot;: &quot;A String&quot;, # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
14431443
&quot;partitionCount&quot;: &quot;A String&quot;, # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.
1444-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were at the given time. This may not be older than 270 seconds.
1444+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were 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.
14451445
&quot;structuredQuery&quot;: { # A Firestore query. # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.
14461446
&quot;endAt&quot;: { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
14471447
&quot;before&quot;: True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.
@@ -1752,13 +1752,13 @@ <h3>Method Details</h3>
17521752
{ # The request for Firestore.RunAggregationQuery.
17531753
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.
17541754
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1755-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
1755+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents 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.
17561756
},
17571757
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
17581758
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
17591759
},
17601760
},
1761-
&quot;readTime&quot;: &quot;A String&quot;, # Executes the query at the given timestamp. Requires: * Cannot be more than 270 seconds in the past.
1761+
&quot;readTime&quot;: &quot;A String&quot;, # Executes the query at the given timestamp. 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.
17621762
&quot;structuredAggregationQuery&quot;: { # Firestore query for running an aggregation over a StructuredQuery. # An aggregation query.
17631763
&quot;aggregations&quot;: [ # Optional. Series of aggregations to apply over the results of the `structured_query`. Requires: * A minimum of one and maximum of five aggregations per query.
17641764
{ # Defines an aggregation that produces a single result.
@@ -1953,13 +1953,13 @@ <h3>Method Details</h3>
19531953
{ # The request for Firestore.RunQuery.
19541954
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
19551955
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1956-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
1956+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents 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.
19571957
},
19581958
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
19591959
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
19601960
},
19611961
},
1962-
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were at the given time. This may not be older than 270 seconds.
1962+
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents as they were 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.
19631963
&quot;structuredQuery&quot;: { # A Firestore query. # A structured query.
19641964
&quot;endAt&quot;: { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
19651965
&quot;before&quot;: True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query.

0 commit comments

Comments
 (0)