You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1.projects.databases.documents.html
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -161,13 +161,13 @@ <h3>Method Details</h3>
161
161
},
162
162
"newTransaction": { # 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.
163
163
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
164
-
"readTime": "A String", # Reads documents at the given time. This may not be older than 60 seconds.
164
+
"readTime": "A String", # 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.
165
165
},
166
166
"readWrite": { # 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.
167
167
"retryTransaction": "A String", # An optional transaction to retry.
168
168
},
169
169
},
170
-
"readTime": "A String", # Reads documents as they were at the given time. This may not be older than 270 seconds.
170
+
"readTime": "A String", # 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.
171
171
"transaction": "A String", # Reads documents in a transaction.
172
172
}
173
173
@@ -522,7 +522,7 @@ <h3>Method Details</h3>
522
522
{ # The request for Firestore.BeginTransaction.
523
523
"options": { # Options for creating a new transaction. # The options for the transaction. Defaults to a read-write transaction.
524
524
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
525
-
"readTime": "A String", # Reads documents at the given time. This may not be older than 60 seconds.
525
+
"readTime": "A String", # 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.
526
526
},
527
527
"readWrite": { # 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.
528
528
"retryTransaction": "A String", # An optional transaction to retry.
@@ -941,7 +941,7 @@ <h3>Method Details</h3>
941
941
Args:
942
942
name: string, Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
943
943
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.
945
945
transaction: string, Reads the document in a transaction.
946
946
x__xgafv: string, V1 error format.
947
947
Allowed values
@@ -995,7 +995,7 @@ <h3>Method Details</h3>
995
995
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`.
996
996
pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
997
997
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.
999
999
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`.
1000
1000
transaction: string, Perform the read as part of an already active transaction.
1001
1001
x__xgafv: string, V1 error format.
@@ -1056,7 +1056,7 @@ <h3>Method Details</h3>
1056
1056
{ # The request for Firestore.ListCollectionIds.
1057
1057
"pageSize": 42, # The maximum number of results to return.
1058
1058
"pageToken": "A String", # A page token. Must be a value from ListCollectionIdsResponse.
1059
-
"readTime": "A String", # Reads documents as they were at the given time. This may not be older than 270 seconds.
1059
+
"readTime": "A String", # 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.
1060
1060
}
1061
1061
1062
1062
x__xgafv: string, V1 error format.
@@ -1100,7 +1100,7 @@ <h3>Method Details</h3>
1100
1100
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`.
1101
1101
pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
1102
1102
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.
1104
1104
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`.
1105
1105
transaction: string, Perform the read as part of an already active transaction.
1106
1106
x__xgafv: string, V1 error format.
@@ -1441,7 +1441,7 @@ <h3>Method Details</h3>
1441
1441
"pageSize": 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`.
1442
1442
"pageToken": "A String", # 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
1443
1443
"partitionCount": "A String", # 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
-
"readTime": "A String", # Reads documents as they were at the given time. This may not be older than 270 seconds.
1444
+
"readTime": "A String", # 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.
1445
1445
"structuredQuery": { # 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.
1446
1446
"endAt": { # 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.
1447
1447
"before": 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>
1752
1752
{ # The request for Firestore.RunAggregationQuery.
1753
1753
"newTransaction": { # 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.
1754
1754
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1755
-
"readTime": "A String", # Reads documents at the given time. This may not be older than 60 seconds.
1755
+
"readTime": "A String", # 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.
1756
1756
},
1757
1757
"readWrite": { # 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.
1758
1758
"retryTransaction": "A String", # An optional transaction to retry.
1759
1759
},
1760
1760
},
1761
-
"readTime": "A String", # Executes the query at the given timestamp. Requires: * Cannot be more than 270 seconds in the past.
1761
+
"readTime": "A String", # 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.
1762
1762
"structuredAggregationQuery": { # Firestore query for running an aggregation over a StructuredQuery. # An aggregation query.
1763
1763
"aggregations": [ # 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.
1764
1764
{ # Defines an aggregation that produces a single result.
@@ -1953,13 +1953,13 @@ <h3>Method Details</h3>
1953
1953
{ # The request for Firestore.RunQuery.
1954
1954
"newTransaction": { # 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.
1955
1955
"readOnly": { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
1956
-
"readTime": "A String", # Reads documents at the given time. This may not be older than 60 seconds.
1956
+
"readTime": "A String", # 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.
1957
1957
},
1958
1958
"readWrite": { # 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.
1959
1959
"retryTransaction": "A String", # An optional transaction to retry.
1960
1960
},
1961
1961
},
1962
-
"readTime": "A String", # Reads documents as they were at the given time. This may not be older than 270 seconds.
1962
+
"readTime": "A String", # 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.
1963
1963
"structuredQuery": { # A Firestore query. # A structured query.
1964
1964
"endAt": { # 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.
1965
1965
"before": 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