@maxim_mazurok/gapi.client.firestore-v1 0.3.20260706 → 0.3.20260810
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.
- package/index.d.ts +243 -9
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://firestore.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260810
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -55,6 +55,8 @@ declare namespace gapi.client {
|
|
|
55
55
|
newTransaction?: TransactionOptions;
|
|
56
56
|
/** 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. */
|
|
57
57
|
readTime?: string;
|
|
58
|
+
/** Optional. The request options for this request. */
|
|
59
|
+
requestOptions?: RequestOptions;
|
|
58
60
|
/** Reads documents in a transaction. */
|
|
59
61
|
transaction?: string;
|
|
60
62
|
}
|
|
@@ -71,6 +73,8 @@ declare namespace gapi.client {
|
|
|
71
73
|
interface BatchWriteRequest {
|
|
72
74
|
/** Labels associated with this batch write. */
|
|
73
75
|
labels?: {[P in string]: string};
|
|
76
|
+
/** Optional. The request options for this request. */
|
|
77
|
+
requestOptions?: RequestOptions;
|
|
74
78
|
/** The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. */
|
|
75
79
|
writes?: Write[];
|
|
76
80
|
}
|
|
@@ -83,6 +87,8 @@ declare namespace gapi.client {
|
|
|
83
87
|
interface BeginTransactionRequest {
|
|
84
88
|
/** The options for the transaction. Defaults to a read-write transaction. */
|
|
85
89
|
options?: TransactionOptions;
|
|
90
|
+
/** Optional. The request options for this request. */
|
|
91
|
+
requestOptions?: RequestOptions;
|
|
86
92
|
}
|
|
87
93
|
interface BeginTransactionResponse {
|
|
88
94
|
/** The transaction that was started. */
|
|
@@ -107,6 +113,8 @@ declare namespace gapi.client {
|
|
|
107
113
|
collectionId?: string;
|
|
108
114
|
}
|
|
109
115
|
interface CommitRequest {
|
|
116
|
+
/** Optional. The request options for this request. */
|
|
117
|
+
requestOptions?: RequestOptions;
|
|
110
118
|
/** If set, applies all writes in this transaction, and commits it. */
|
|
111
119
|
transaction?: string;
|
|
112
120
|
/** The writes to apply. Always executed atomically and in order. */
|
|
@@ -190,6 +198,8 @@ declare namespace gapi.client {
|
|
|
190
198
|
newTransaction?: TransactionOptions;
|
|
191
199
|
/** 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. */
|
|
192
200
|
readTime?: string;
|
|
201
|
+
/** Optional. The request options for this request. */
|
|
202
|
+
requestOptions?: RequestOptions;
|
|
193
203
|
/** A pipelined operation. */
|
|
194
204
|
structuredPipeline?: StructuredPipeline;
|
|
195
205
|
/** Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. */
|
|
@@ -373,6 +383,24 @@ declare namespace gapi.client {
|
|
|
373
383
|
/** Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique. */
|
|
374
384
|
namespaceIds?: string[];
|
|
375
385
|
}
|
|
386
|
+
interface GoogleFirestoreAdminV1ChangeStream {
|
|
387
|
+
/** If set, the change stream is scoped to a collection group. */
|
|
388
|
+
collectionGroupScope?: GoogleFirestoreAdminV1CollectionGroupScope;
|
|
389
|
+
/** Output only. The time the Change Stream was created. */
|
|
390
|
+
createTime?: string;
|
|
391
|
+
/** If set, the change stream is scoped to the entire database. */
|
|
392
|
+
databaseScope?: any;
|
|
393
|
+
/** Optional. An etag used to determine which version of the configuration is being edited. */
|
|
394
|
+
etag?: string;
|
|
395
|
+
/** Identifier. The external resource name of the change stream. Format `projects/{project}/databases/{database}/changeStreams/{change_stream}` */
|
|
396
|
+
name?: string;
|
|
397
|
+
/** Required. The retention period of the change stream. This is the amount of time a change event is available on the change stream. Must be from 1 to 7 days, inclusive. The retention_period must be in day granularity, i.e. it must be a multiple of 24 hours. */
|
|
398
|
+
retentionPeriod?: string;
|
|
399
|
+
/** Output only. The time the Change Stream started recording events. */
|
|
400
|
+
startTime?: string;
|
|
401
|
+
/** Output only. The time the Change Stream was last updated. */
|
|
402
|
+
updateTime?: string;
|
|
403
|
+
}
|
|
376
404
|
interface GoogleFirestoreAdminV1CloneDatabaseMetadata {
|
|
377
405
|
/** The name of the database being cloned to. */
|
|
378
406
|
database?: string;
|
|
@@ -411,6 +439,10 @@ declare namespace gapi.client {
|
|
|
411
439
|
/** Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
|
|
412
440
|
kmsKeyName?: string;
|
|
413
441
|
}
|
|
442
|
+
interface GoogleFirestoreAdminV1CollectionGroupScope {
|
|
443
|
+
/** Required. The collection group name. */
|
|
444
|
+
collectionGroupId?: string;
|
|
445
|
+
}
|
|
414
446
|
interface GoogleFirestoreAdminV1CreateDatabaseMetadata {}
|
|
415
447
|
interface GoogleFirestoreAdminV1CustomerManagedEncryptionOptions {
|
|
416
448
|
/** Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
|
|
@@ -445,7 +477,7 @@ declare namespace gapi.client {
|
|
|
445
477
|
earliestVersionTime?: string;
|
|
446
478
|
/** This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */
|
|
447
479
|
etag?: string;
|
|
448
|
-
/** Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise
|
|
480
|
+
/** Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard edition. */
|
|
449
481
|
firestoreDataAccessMode?:
|
|
450
482
|
| 'DATA_ACCESS_MODE_UNSPECIFIED'
|
|
451
483
|
| 'DATA_ACCESS_MODE_ENABLED'
|
|
@@ -456,7 +488,7 @@ declare namespace gapi.client {
|
|
|
456
488
|
keyPrefix?: string;
|
|
457
489
|
/** Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */
|
|
458
490
|
locationId?: string;
|
|
459
|
-
/** Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise
|
|
491
|
+
/** Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard edition. */
|
|
460
492
|
mongodbCompatibleDataAccessMode?:
|
|
461
493
|
| 'DATA_ACCESS_MODE_UNSPECIFIED'
|
|
462
494
|
| 'DATA_ACCESS_MODE_ENABLED'
|
|
@@ -489,6 +521,7 @@ declare namespace gapi.client {
|
|
|
489
521
|
/** Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. */
|
|
490
522
|
versionRetentionPeriod?: string;
|
|
491
523
|
}
|
|
524
|
+
interface GoogleFirestoreAdminV1DatabaseScope {}
|
|
492
525
|
interface GoogleFirestoreAdminV1DeleteDatabaseMetadata {}
|
|
493
526
|
interface GoogleFirestoreAdminV1DisableUserCredsRequest {}
|
|
494
527
|
interface GoogleFirestoreAdminV1EnableUserCredsRequest {}
|
|
@@ -617,11 +650,11 @@ declare namespace gapi.client {
|
|
|
617
650
|
apiScope?: 'ANY_API' | 'DATASTORE_MODE_API' | 'MONGODB_COMPATIBLE_API';
|
|
618
651
|
/** Immutable. The density configuration of the index. */
|
|
619
652
|
density?: 'DENSITY_UNSPECIFIED' | 'SPARSE_ALL' | 'SPARSE_ANY' | 'DENSE';
|
|
620
|
-
/** The fields supported by this index.
|
|
653
|
+
/** The fields supported by this index. At most 100 fields may be specified. In Standard edition databases only: - At least 2 fields must be specified. - The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in the index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). */
|
|
621
654
|
fields?: GoogleFirestoreAdminV1IndexField[];
|
|
622
655
|
/** Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope. */
|
|
623
656
|
multikey?: boolean;
|
|
624
|
-
/**
|
|
657
|
+
/** A server-defined name for this index. Output only. When used in the google.firestore.admin.v1.Index resource, the value is of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` When used in the google.firestore.admin.v1.Field resource, the value is empty. */
|
|
625
658
|
name?: string;
|
|
626
659
|
/** Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. */
|
|
627
660
|
queryScope?:
|
|
@@ -698,6 +731,10 @@ declare namespace gapi.client {
|
|
|
698
731
|
/** List of locations that existing backups were not able to be fetched from. Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error. */
|
|
699
732
|
unreachable?: string[];
|
|
700
733
|
}
|
|
734
|
+
interface GoogleFirestoreAdminV1ListChangeStreamsResponse {
|
|
735
|
+
/** The list of change streams. */
|
|
736
|
+
changeStreams?: GoogleFirestoreAdminV1ChangeStream[];
|
|
737
|
+
}
|
|
701
738
|
interface GoogleFirestoreAdminV1ListDatabasesResponse {
|
|
702
739
|
/** The databases in the project. */
|
|
703
740
|
databases?: GoogleFirestoreAdminV1Database[];
|
|
@@ -825,7 +862,22 @@ declare namespace gapi.client {
|
|
|
825
862
|
/** The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time. */
|
|
826
863
|
expirationOffset?: string;
|
|
827
864
|
}
|
|
828
|
-
interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {
|
|
865
|
+
interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {
|
|
866
|
+
/** The time this operation completed. Will be unset if operation still in progress. */
|
|
867
|
+
endTime?: string;
|
|
868
|
+
/** The time this operation started. */
|
|
869
|
+
startTime?: string;
|
|
870
|
+
/** The state of the operation. */
|
|
871
|
+
state?:
|
|
872
|
+
| 'OPERATION_STATE_UNSPECIFIED'
|
|
873
|
+
| 'INITIALIZING'
|
|
874
|
+
| 'PROCESSING'
|
|
875
|
+
| 'CANCELLING'
|
|
876
|
+
| 'FINALIZING'
|
|
877
|
+
| 'SUCCESSFUL'
|
|
878
|
+
| 'FAILED'
|
|
879
|
+
| 'CANCELLED';
|
|
880
|
+
}
|
|
829
881
|
interface GoogleFirestoreAdminV1UserCreds {
|
|
830
882
|
/** Output only. The time the user creds were created. */
|
|
831
883
|
createTime?: string;
|
|
@@ -892,6 +944,8 @@ declare namespace gapi.client {
|
|
|
892
944
|
pageToken?: string;
|
|
893
945
|
/** 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. */
|
|
894
946
|
readTime?: string;
|
|
947
|
+
/** Optional. The request options for this request. */
|
|
948
|
+
requestOptions?: RequestOptions;
|
|
895
949
|
}
|
|
896
950
|
interface ListCollectionIdsResponse {
|
|
897
951
|
/** The collection ids. */
|
|
@@ -912,6 +966,8 @@ declare namespace gapi.client {
|
|
|
912
966
|
labels?: {[P in string]: string};
|
|
913
967
|
/** The ID of a target to remove from this stream. */
|
|
914
968
|
removeTarget?: number;
|
|
969
|
+
/** Optional. The request options for the request. */
|
|
970
|
+
requestOptions?: RequestOptions;
|
|
915
971
|
}
|
|
916
972
|
interface ListenResponse {
|
|
917
973
|
/** A Document has changed. */
|
|
@@ -962,6 +1018,8 @@ declare namespace gapi.client {
|
|
|
962
1018
|
partitionCount?: string;
|
|
963
1019
|
/** 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. */
|
|
964
1020
|
readTime?: string;
|
|
1021
|
+
/** Optional. The request options for the request. */
|
|
1022
|
+
requestOptions?: RequestOptions;
|
|
965
1023
|
/** 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. */
|
|
966
1024
|
structuredQuery?: StructuredQuery;
|
|
967
1025
|
}
|
|
@@ -1006,7 +1064,13 @@ declare namespace gapi.client {
|
|
|
1006
1064
|
/** An optional transaction to retry. */
|
|
1007
1065
|
retryTransaction?: string;
|
|
1008
1066
|
}
|
|
1067
|
+
interface RequestOptions {
|
|
1068
|
+
/** Optional. The request tags for the request. */
|
|
1069
|
+
requestTags?: string[];
|
|
1070
|
+
}
|
|
1009
1071
|
interface RollbackRequest {
|
|
1072
|
+
/** Optional. The request options for this request. */
|
|
1073
|
+
requestOptions?: RequestOptions;
|
|
1010
1074
|
/** Required. The transaction to roll back. */
|
|
1011
1075
|
transaction?: string;
|
|
1012
1076
|
}
|
|
@@ -1017,6 +1081,8 @@ declare namespace gapi.client {
|
|
|
1017
1081
|
newTransaction?: TransactionOptions;
|
|
1018
1082
|
/** 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. */
|
|
1019
1083
|
readTime?: string;
|
|
1084
|
+
/** Optional. The request options for the request. */
|
|
1085
|
+
requestOptions?: RequestOptions;
|
|
1020
1086
|
/** An aggregation query. */
|
|
1021
1087
|
structuredAggregationQuery?: StructuredAggregationQuery;
|
|
1022
1088
|
/** Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in. */
|
|
@@ -1039,6 +1105,8 @@ declare namespace gapi.client {
|
|
|
1039
1105
|
newTransaction?: TransactionOptions;
|
|
1040
1106
|
/** 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. */
|
|
1041
1107
|
readTime?: string;
|
|
1108
|
+
/** Optional. The request options for this request. */
|
|
1109
|
+
requestOptions?: RequestOptions;
|
|
1042
1110
|
/** A structured query. */
|
|
1043
1111
|
structuredQuery?: StructuredQuery;
|
|
1044
1112
|
/** Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. */
|
|
@@ -1156,11 +1224,11 @@ declare namespace gapi.client {
|
|
|
1156
1224
|
| 'IS_NOT_NULL';
|
|
1157
1225
|
}
|
|
1158
1226
|
interface Value {
|
|
1159
|
-
/** An array value.
|
|
1227
|
+
/** An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value. */
|
|
1160
1228
|
arrayValue?: ArrayValue;
|
|
1161
1229
|
/** A boolean value. */
|
|
1162
1230
|
booleanValue?: boolean;
|
|
1163
|
-
/** A bytes value.
|
|
1231
|
+
/** A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */
|
|
1164
1232
|
bytesValue?: string;
|
|
1165
1233
|
/** A double value. */
|
|
1166
1234
|
doubleValue?: number;
|
|
@@ -1180,7 +1248,7 @@ declare namespace gapi.client {
|
|
|
1180
1248
|
pipelineValue?: Pipeline;
|
|
1181
1249
|
/** A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */
|
|
1182
1250
|
referenceValue?: string;
|
|
1183
|
-
/** A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. */
|
|
1251
|
+
/** A string value. In Standard edition databases: * The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the UTF-8 representation are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */
|
|
1184
1252
|
stringValue?: string;
|
|
1185
1253
|
/** A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. */
|
|
1186
1254
|
timestampValue?: string;
|
|
@@ -1204,6 +1272,8 @@ declare namespace gapi.client {
|
|
|
1204
1272
|
interface WriteRequest {
|
|
1205
1273
|
/** Labels associated with this write request. */
|
|
1206
1274
|
labels?: {[P in string]: string};
|
|
1275
|
+
/** Optional. The request options for the request. */
|
|
1276
|
+
requestOptions?: RequestOptions;
|
|
1207
1277
|
/** The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */
|
|
1208
1278
|
streamId?: string;
|
|
1209
1279
|
/** A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. */
|
|
@@ -1430,6 +1500,153 @@ declare namespace gapi.client {
|
|
|
1430
1500
|
body: GoogleFirestoreAdminV1BackupSchedule,
|
|
1431
1501
|
): Request<GoogleFirestoreAdminV1BackupSchedule>;
|
|
1432
1502
|
}
|
|
1503
|
+
interface ChangeStreamsResource {
|
|
1504
|
+
/** Creates a new change stream for the database. */
|
|
1505
|
+
create(request: {
|
|
1506
|
+
/** V1 error format. */
|
|
1507
|
+
'$.xgafv'?: '1' | '2';
|
|
1508
|
+
/** OAuth access token. */
|
|
1509
|
+
access_token?: string;
|
|
1510
|
+
/** Data format for response. */
|
|
1511
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1512
|
+
/** JSONP */
|
|
1513
|
+
callback?: string;
|
|
1514
|
+
/** Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number. */
|
|
1515
|
+
changeStreamId?: string;
|
|
1516
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1517
|
+
fields?: string;
|
|
1518
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1519
|
+
key?: string;
|
|
1520
|
+
/** OAuth 2.0 token for the current user. */
|
|
1521
|
+
oauth_token?: string;
|
|
1522
|
+
/** Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`. */
|
|
1523
|
+
parent: string;
|
|
1524
|
+
/** Returns response with indentations and line breaks. */
|
|
1525
|
+
prettyPrint?: boolean;
|
|
1526
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1527
|
+
quotaUser?: string;
|
|
1528
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1529
|
+
upload_protocol?: string;
|
|
1530
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1531
|
+
uploadType?: string;
|
|
1532
|
+
/** Request body */
|
|
1533
|
+
resource: GoogleFirestoreAdminV1ChangeStream;
|
|
1534
|
+
}): Request<GoogleFirestoreAdminV1ChangeStream>;
|
|
1535
|
+
create(
|
|
1536
|
+
request: {
|
|
1537
|
+
/** V1 error format. */
|
|
1538
|
+
'$.xgafv'?: '1' | '2';
|
|
1539
|
+
/** OAuth access token. */
|
|
1540
|
+
access_token?: string;
|
|
1541
|
+
/** Data format for response. */
|
|
1542
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1543
|
+
/** JSONP */
|
|
1544
|
+
callback?: string;
|
|
1545
|
+
/** Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number. */
|
|
1546
|
+
changeStreamId?: string;
|
|
1547
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1548
|
+
fields?: string;
|
|
1549
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1550
|
+
key?: string;
|
|
1551
|
+
/** OAuth 2.0 token for the current user. */
|
|
1552
|
+
oauth_token?: string;
|
|
1553
|
+
/** Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`. */
|
|
1554
|
+
parent: string;
|
|
1555
|
+
/** Returns response with indentations and line breaks. */
|
|
1556
|
+
prettyPrint?: boolean;
|
|
1557
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1558
|
+
quotaUser?: string;
|
|
1559
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1560
|
+
upload_protocol?: string;
|
|
1561
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1562
|
+
uploadType?: string;
|
|
1563
|
+
},
|
|
1564
|
+
body: GoogleFirestoreAdminV1ChangeStream,
|
|
1565
|
+
): Request<GoogleFirestoreAdminV1ChangeStream>;
|
|
1566
|
+
/** Deletes a change stream. */
|
|
1567
|
+
delete(request?: {
|
|
1568
|
+
/** V1 error format. */
|
|
1569
|
+
'$.xgafv'?: '1' | '2';
|
|
1570
|
+
/** OAuth access token. */
|
|
1571
|
+
access_token?: string;
|
|
1572
|
+
/** Data format for response. */
|
|
1573
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1574
|
+
/** JSONP */
|
|
1575
|
+
callback?: string;
|
|
1576
|
+
/** Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail. */
|
|
1577
|
+
etag?: string;
|
|
1578
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1579
|
+
fields?: string;
|
|
1580
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1581
|
+
key?: string;
|
|
1582
|
+
/** Required. The name of the change stream to delete. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`. */
|
|
1583
|
+
name: string;
|
|
1584
|
+
/** OAuth 2.0 token for the current user. */
|
|
1585
|
+
oauth_token?: string;
|
|
1586
|
+
/** Returns response with indentations and line breaks. */
|
|
1587
|
+
prettyPrint?: boolean;
|
|
1588
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1589
|
+
quotaUser?: string;
|
|
1590
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1591
|
+
upload_protocol?: string;
|
|
1592
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1593
|
+
uploadType?: string;
|
|
1594
|
+
}): Request<{}>;
|
|
1595
|
+
/** Gets information about a change stream. */
|
|
1596
|
+
get(request?: {
|
|
1597
|
+
/** V1 error format. */
|
|
1598
|
+
'$.xgafv'?: '1' | '2';
|
|
1599
|
+
/** OAuth access token. */
|
|
1600
|
+
access_token?: string;
|
|
1601
|
+
/** Data format for response. */
|
|
1602
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1603
|
+
/** JSONP */
|
|
1604
|
+
callback?: string;
|
|
1605
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1606
|
+
fields?: string;
|
|
1607
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1608
|
+
key?: string;
|
|
1609
|
+
/** Required. The name of the change stream to retrieve. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`. */
|
|
1610
|
+
name: string;
|
|
1611
|
+
/** OAuth 2.0 token for the current user. */
|
|
1612
|
+
oauth_token?: string;
|
|
1613
|
+
/** Returns response with indentations and line breaks. */
|
|
1614
|
+
prettyPrint?: boolean;
|
|
1615
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1616
|
+
quotaUser?: string;
|
|
1617
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1618
|
+
upload_protocol?: string;
|
|
1619
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1620
|
+
uploadType?: string;
|
|
1621
|
+
}): Request<GoogleFirestoreAdminV1ChangeStream>;
|
|
1622
|
+
/** Lists all change streams in a database. */
|
|
1623
|
+
list(request?: {
|
|
1624
|
+
/** V1 error format. */
|
|
1625
|
+
'$.xgafv'?: '1' | '2';
|
|
1626
|
+
/** OAuth access token. */
|
|
1627
|
+
access_token?: string;
|
|
1628
|
+
/** Data format for response. */
|
|
1629
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1630
|
+
/** JSONP */
|
|
1631
|
+
callback?: string;
|
|
1632
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1633
|
+
fields?: string;
|
|
1634
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1635
|
+
key?: string;
|
|
1636
|
+
/** OAuth 2.0 token for the current user. */
|
|
1637
|
+
oauth_token?: string;
|
|
1638
|
+
/** Required. The parent database to list change streams from. Format is `projects/{project}/databases/{database}`. */
|
|
1639
|
+
parent: string;
|
|
1640
|
+
/** Returns response with indentations and line breaks. */
|
|
1641
|
+
prettyPrint?: boolean;
|
|
1642
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1643
|
+
quotaUser?: string;
|
|
1644
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1645
|
+
upload_protocol?: string;
|
|
1646
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1647
|
+
uploadType?: string;
|
|
1648
|
+
}): Request<GoogleFirestoreAdminV1ListChangeStreamsResponse>;
|
|
1649
|
+
}
|
|
1433
1650
|
interface FieldsResource {
|
|
1434
1651
|
/** Gets the metadata and configuration for a Field. */
|
|
1435
1652
|
get(request?: {
|
|
@@ -1966,6 +2183,8 @@ declare namespace gapi.client {
|
|
|
1966
2183
|
prettyPrint?: boolean;
|
|
1967
2184
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1968
2185
|
quotaUser?: string;
|
|
2186
|
+
/** Optional. The request tags for the request. */
|
|
2187
|
+
'requestOptions.requestTags'?: string | string[];
|
|
1969
2188
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1970
2189
|
upload_protocol?: string;
|
|
1971
2190
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2001,6 +2220,8 @@ declare namespace gapi.client {
|
|
|
2001
2220
|
prettyPrint?: boolean;
|
|
2002
2221
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2003
2222
|
quotaUser?: string;
|
|
2223
|
+
/** Optional. The request tags for the request. */
|
|
2224
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2004
2225
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2005
2226
|
upload_protocol?: string;
|
|
2006
2227
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2034,6 +2255,8 @@ declare namespace gapi.client {
|
|
|
2034
2255
|
prettyPrint?: boolean;
|
|
2035
2256
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2036
2257
|
quotaUser?: string;
|
|
2258
|
+
/** Optional. The request tags for the request. */
|
|
2259
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2037
2260
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2038
2261
|
upload_protocol?: string;
|
|
2039
2262
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2123,6 +2346,8 @@ declare namespace gapi.client {
|
|
|
2123
2346
|
quotaUser?: string;
|
|
2124
2347
|
/** 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. */
|
|
2125
2348
|
readTime?: string;
|
|
2349
|
+
/** Optional. The request tags for the request. */
|
|
2350
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2126
2351
|
/** Reads the document in a transaction. */
|
|
2127
2352
|
transaction?: string;
|
|
2128
2353
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -2166,6 +2391,8 @@ declare namespace gapi.client {
|
|
|
2166
2391
|
readTime?: string;
|
|
2167
2392
|
/** Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */
|
|
2168
2393
|
recursive?: boolean;
|
|
2394
|
+
/** Optional. The request tags for the request. */
|
|
2395
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2169
2396
|
/** 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`. */
|
|
2170
2397
|
showMissing?: boolean;
|
|
2171
2398
|
/** Perform the read as part of an already active transaction. */
|
|
@@ -2269,6 +2496,8 @@ declare namespace gapi.client {
|
|
|
2269
2496
|
readTime?: string;
|
|
2270
2497
|
/** Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */
|
|
2271
2498
|
recursive?: boolean;
|
|
2499
|
+
/** Optional. The request tags for the request. */
|
|
2500
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2272
2501
|
/** 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`. */
|
|
2273
2502
|
showMissing?: boolean;
|
|
2274
2503
|
/** Perform the read as part of an already active transaction. */
|
|
@@ -2422,6 +2651,8 @@ declare namespace gapi.client {
|
|
|
2422
2651
|
prettyPrint?: boolean;
|
|
2423
2652
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2424
2653
|
quotaUser?: string;
|
|
2654
|
+
/** Optional. The request tags for the request. */
|
|
2655
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2425
2656
|
/** The list of field paths in the mask. See Document.fields for a field path syntax reference. */
|
|
2426
2657
|
'updateMask.fieldPaths'?: string | string[];
|
|
2427
2658
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -2459,6 +2690,8 @@ declare namespace gapi.client {
|
|
|
2459
2690
|
prettyPrint?: boolean;
|
|
2460
2691
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2461
2692
|
quotaUser?: string;
|
|
2693
|
+
/** Optional. The request tags for the request. */
|
|
2694
|
+
'requestOptions.requestTags'?: string | string[];
|
|
2462
2695
|
/** The list of field paths in the mask. See Document.fields for a field path syntax reference. */
|
|
2463
2696
|
'updateMask.fieldPaths'?: string | string[];
|
|
2464
2697
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -3670,6 +3903,7 @@ declare namespace gapi.client {
|
|
|
3670
3903
|
body: GoogleFirestoreAdminV1RestoreDatabaseRequest,
|
|
3671
3904
|
): Request<GoogleLongrunningOperation>;
|
|
3672
3905
|
backupSchedules: BackupSchedulesResource;
|
|
3906
|
+
changeStreams: ChangeStreamsResource;
|
|
3673
3907
|
collectionGroups: CollectionGroupsResource;
|
|
3674
3908
|
documents: DocumentsResource;
|
|
3675
3909
|
operations: OperationsResource;
|