@maxim_mazurok/gapi.client.firestore-v1 0.1.20260310 → 0.2.20260310

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.
Files changed (2) hide show
  1. package/index.d.ts +324 -208
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -122,7 +122,7 @@ declare namespace gapi.client {
122
122
  /** The list of filters to combine. Requires: * At least one filter is present. */
123
123
  filters?: Filter[];
124
124
  /** The operator for combining multiple filters. */
125
- op?: string;
125
+ op?: 'OPERATOR_UNSPECIFIED' | 'AND' | 'OR';
126
126
  }
127
127
  interface Count {
128
128
  /** Optional. Optional constraint on the maximum number of documents to count. This provides a way to set an upper bound on the number of documents to scan, limiting latency, and cost. Unspecified is interpreted as no bound. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be greater than zero when present. */
@@ -239,7 +239,18 @@ declare namespace gapi.client {
239
239
  /** The field to filter by. */
240
240
  field?: FieldReference;
241
241
  /** The operator to filter by. */
242
- op?: string;
242
+ op?:
243
+ | 'OPERATOR_UNSPECIFIED'
244
+ | 'LESS_THAN'
245
+ | 'LESS_THAN_OR_EQUAL'
246
+ | 'GREATER_THAN'
247
+ | 'GREATER_THAN_OR_EQUAL'
248
+ | 'EQUAL'
249
+ | 'NOT_EQUAL'
250
+ | 'ARRAY_CONTAINS'
251
+ | 'IN'
252
+ | 'ARRAY_CONTAINS_ANY'
253
+ | 'NOT_IN';
243
254
  /** The value to compare to. */
244
255
  value?: Value;
245
256
  }
@@ -261,7 +272,7 @@ declare namespace gapi.client {
261
272
  /** Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. */
262
273
  removeAllFromArray?: ArrayValue;
263
274
  /** Sets the field to the given server value. */
264
- setToServerValue?: string;
275
+ setToServerValue?: 'SERVER_VALUE_UNSPECIFIED' | 'REQUEST_TIME';
265
276
  }
266
277
  interface Filter {
267
278
  /** A composite filter. */
@@ -273,7 +284,11 @@ declare namespace gapi.client {
273
284
  }
274
285
  interface FindNearest {
275
286
  /** Required. The distance measure to use, required. */
276
- distanceMeasure?: string;
287
+ distanceMeasure?:
288
+ | 'DISTANCE_MEASURE_UNSPECIFIED'
289
+ | 'EUCLIDEAN'
290
+ | 'COSINE'
291
+ | 'DOT_PRODUCT';
277
292
  /** Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. */
278
293
  distanceResultField?: string;
279
294
  /** Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance >= distance_threshold` */
@@ -305,7 +320,7 @@ declare namespace gapi.client {
305
320
  /** Output only. The backup contains an externally consistent copy of the database at this time. */
306
321
  snapshotTime?: string;
307
322
  /** Output only. The current state of the backup. */
308
- state?: string;
323
+ state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'NOT_AVAILABLE';
309
324
  /** Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then. */
310
325
  stats?: GoogleFirestoreAdminV1Stats;
311
326
  }
@@ -335,7 +350,15 @@ declare namespace gapi.client {
335
350
  /** Which namespace IDs are being deleted. */
336
351
  namespaceIds?: string[];
337
352
  /** The state of the operation. */
338
- operationState?: string;
353
+ operationState?:
354
+ | 'OPERATION_STATE_UNSPECIFIED'
355
+ | 'INITIALIZING'
356
+ | 'PROCESSING'
357
+ | 'CANCELLING'
358
+ | 'FINALIZING'
359
+ | 'SUCCESSFUL'
360
+ | 'FAILED'
361
+ | 'CANCELLED';
339
362
  /** The progress, in bytes, of this operation. */
340
363
  progressBytes?: GoogleFirestoreAdminV1Progress;
341
364
  /** The progress, in documents, of this operation. */
@@ -357,7 +380,15 @@ declare namespace gapi.client {
357
380
  /** The time the clone finished, unset for ongoing clones. */
358
381
  endTime?: string;
359
382
  /** The operation state of the clone. */
360
- operationState?: string;
383
+ operationState?:
384
+ | 'OPERATION_STATE_UNSPECIFIED'
385
+ | 'INITIALIZING'
386
+ | 'PROCESSING'
387
+ | 'CANCELLING'
388
+ | 'FINALIZING'
389
+ | 'SUCCESSFUL'
390
+ | 'FAILED'
391
+ | 'CANCELLED';
361
392
  /** The snapshot from which this database was cloned. */
362
393
  pitrSnapshot?: GoogleFirestoreAdminV1PitrSnapshot;
363
394
  /** How far along the clone is as an estimated percentage of remaining time. */
@@ -389,17 +420,30 @@ declare namespace gapi.client {
389
420
  interface GoogleFirestoreAdminV1DailyRecurrence {}
390
421
  interface GoogleFirestoreAdminV1Database {
391
422
  /** The App Engine integration mode to use for this database. */
392
- appEngineIntegrationMode?: string;
423
+ appEngineIntegrationMode?:
424
+ | 'APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED'
425
+ | 'ENABLED'
426
+ | 'DISABLED';
393
427
  /** Optional. Presence indicates CMEK is enabled for this database. */
394
428
  cmekConfig?: GoogleFirestoreAdminV1CmekConfig;
395
429
  /** 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. */
396
- concurrencyMode?: string;
430
+ concurrencyMode?:
431
+ | 'CONCURRENCY_MODE_UNSPECIFIED'
432
+ | 'OPTIMISTIC'
433
+ | 'PESSIMISTIC'
434
+ | 'OPTIMISTIC_WITH_ENTITY_GROUPS';
397
435
  /** Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. */
398
436
  createTime?: string;
399
437
  /** Immutable. The edition of the database. */
400
- databaseEdition?: string;
438
+ databaseEdition?:
439
+ | 'DATABASE_EDITION_UNSPECIFIED'
440
+ | 'STANDARD'
441
+ | 'ENTERPRISE';
401
442
  /** State of delete protection for the database. */
402
- deleteProtectionState?: string;
443
+ deleteProtectionState?:
444
+ | 'DELETE_PROTECTION_STATE_UNSPECIFIED'
445
+ | 'DELETE_PROTECTION_DISABLED'
446
+ | 'DELETE_PROTECTION_ENABLED';
403
447
  /** Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. */
404
448
  deleteTime?: string;
405
449
  /** Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. */
@@ -407,7 +451,10 @@ declare namespace gapi.client {
407
451
  /** 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. */
408
452
  etag?: string;
409
453
  /** 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. */
410
- firestoreDataAccessMode?: string;
454
+ firestoreDataAccessMode?:
455
+ | 'DATA_ACCESS_MODE_UNSPECIFIED'
456
+ | 'DATA_ACCESS_MODE_ENABLED'
457
+ | 'DATA_ACCESS_MODE_DISABLED';
411
458
  /** Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. */
412
459
  freeTier?: boolean;
413
460
  /** Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). */
@@ -415,21 +462,33 @@ declare namespace gapi.client {
415
462
  /** Required. The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */
416
463
  locationId?: string;
417
464
  /** 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. */
418
- mongodbCompatibleDataAccessMode?: string;
465
+ mongodbCompatibleDataAccessMode?:
466
+ | 'DATA_ACCESS_MODE_UNSPECIFIED'
467
+ | 'DATA_ACCESS_MODE_ENABLED'
468
+ | 'DATA_ACCESS_MODE_DISABLED';
419
469
  /** The resource name of the Database. Format: `projects/{project}/databases/{database}` */
420
470
  name?: string;
421
471
  /** Whether to enable the PITR feature on this database. */
422
- pointInTimeRecoveryEnablement?: string;
472
+ pointInTimeRecoveryEnablement?:
473
+ | 'POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED'
474
+ | 'POINT_IN_TIME_RECOVERY_ENABLED'
475
+ | 'POINT_IN_TIME_RECOVERY_DISABLED';
423
476
  /** Output only. The database resource's prior database ID. This field is only populated for deleted databases. */
424
477
  previousId?: string;
425
478
  /** Immutable. The default Realtime Updates mode to use for this database. */
426
- realtimeUpdatesMode?: string;
479
+ realtimeUpdatesMode?:
480
+ | 'REALTIME_UPDATES_MODE_UNSPECIFIED'
481
+ | 'REALTIME_UPDATES_MODE_ENABLED'
482
+ | 'REALTIME_UPDATES_MODE_DISABLED';
427
483
  /** Output only. Information about the provenance of this database. */
428
484
  sourceInfo?: GoogleFirestoreAdminV1SourceInfo;
429
485
  /** Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */
430
486
  tags?: {[P in string]: string};
431
487
  /** Required. The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. */
432
- type?: string;
488
+ type?:
489
+ | 'DATABASE_TYPE_UNSPECIFIED'
490
+ | 'FIRESTORE_NATIVE'
491
+ | 'DATASTORE_MODE';
433
492
  /** Output only. The system-generated UUID4 for this Database. */
434
493
  uid?: string;
435
494
  /** Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. */
@@ -456,7 +515,15 @@ declare namespace gapi.client {
456
515
  /** Which namespace IDs are being exported. */
457
516
  namespaceIds?: string[];
458
517
  /** The state of the export operation. */
459
- operationState?: string;
518
+ operationState?:
519
+ | 'OPERATION_STATE_UNSPECIFIED'
520
+ | 'INITIALIZING'
521
+ | 'PROCESSING'
522
+ | 'CANCELLING'
523
+ | 'FINALIZING'
524
+ | 'SUCCESSFUL'
525
+ | 'FAILED'
526
+ | 'CANCELLED';
460
527
  /** Where the documents are being exported to. */
461
528
  outputUriPrefix?: string;
462
529
  /** The progress, in bytes, of this operation. */
@@ -504,7 +571,15 @@ declare namespace gapi.client {
504
571
  /** The time this operation started. */
505
572
  startTime?: string;
506
573
  /** The state of the operation. */
507
- state?: string;
574
+ state?:
575
+ | 'OPERATION_STATE_UNSPECIFIED'
576
+ | 'INITIALIZING'
577
+ | 'PROCESSING'
578
+ | 'CANCELLING'
579
+ | 'FINALIZING'
580
+ | 'SUCCESSFUL'
581
+ | 'FAILED'
582
+ | 'CANCELLED';
508
583
  /** Describes the deltas of TTL configuration. */
509
584
  ttlConfigDelta?: GoogleFirestoreAdminV1TtlConfigDelta;
510
585
  }
@@ -520,7 +595,15 @@ declare namespace gapi.client {
520
595
  /** Which namespace IDs are being imported. */
521
596
  namespaceIds?: string[];
522
597
  /** The state of the import operation. */
523
- operationState?: string;
598
+ operationState?:
599
+ | 'OPERATION_STATE_UNSPECIFIED'
600
+ | 'INITIALIZING'
601
+ | 'PROCESSING'
602
+ | 'CANCELLING'
603
+ | 'FINALIZING'
604
+ | 'SUCCESSFUL'
605
+ | 'FAILED'
606
+ | 'CANCELLED';
524
607
  /** The progress, in bytes, of this operation. */
525
608
  progressBytes?: GoogleFirestoreAdminV1Progress;
526
609
  /** The progress, in documents, of this operation. */
@@ -538,9 +621,9 @@ declare namespace gapi.client {
538
621
  }
539
622
  interface GoogleFirestoreAdminV1Index {
540
623
  /** The API scope supported by this index. */
541
- apiScope?: string;
624
+ apiScope?: 'ANY_API' | 'DATASTORE_MODE_API' | 'MONGODB_COMPATIBLE_API';
542
625
  /** Immutable. The density configuration of the index. */
543
- density?: string;
626
+ density?: 'DENSITY_UNSPECIFIED' | 'SPARSE_ALL' | 'SPARSE_ANY' | 'DENSE';
544
627
  /** The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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 a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. */
545
628
  fields?: GoogleFirestoreAdminV1IndexField[];
546
629
  /** 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. */
@@ -548,11 +631,15 @@ declare namespace gapi.client {
548
631
  /** Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */
549
632
  name?: string;
550
633
  /** 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. */
551
- queryScope?: string;
634
+ queryScope?:
635
+ | 'QUERY_SCOPE_UNSPECIFIED'
636
+ | 'COLLECTION'
637
+ | 'COLLECTION_GROUP'
638
+ | 'COLLECTION_RECURSIVE';
552
639
  /** Optional. The number of shards for the index. */
553
640
  shardCount?: number;
554
641
  /** Output only. The serving state of the index. */
555
- state?: string;
642
+ state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'NEEDS_REPAIR';
556
643
  /** Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. */
557
644
  unique?: boolean;
558
645
  }
@@ -568,17 +655,17 @@ declare namespace gapi.client {
568
655
  }
569
656
  interface GoogleFirestoreAdminV1IndexConfigDelta {
570
657
  /** Specifies how the index is changing. */
571
- changeType?: string;
658
+ changeType?: 'CHANGE_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE';
572
659
  /** The index being changed. */
573
660
  index?: GoogleFirestoreAdminV1Index;
574
661
  }
575
662
  interface GoogleFirestoreAdminV1IndexField {
576
663
  /** Indicates that this field supports operations on `array_value`s. */
577
- arrayConfig?: string;
664
+ arrayConfig?: 'ARRAY_CONFIG_UNSPECIFIED' | 'CONTAINS';
578
665
  /** Can be __name__. For single field indexes, this must match the name of the field or may be omitted. */
579
666
  fieldPath?: string;
580
667
  /** Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. */
581
- order?: string;
668
+ order?: 'ORDER_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
582
669
  /** Indicates that this field supports nearest neighbor and distance operations on vector. */
583
670
  vectorConfig?: GoogleFirestoreAdminV1VectorConfig;
584
671
  }
@@ -594,7 +681,15 @@ declare namespace gapi.client {
594
681
  /** The time this operation started. */
595
682
  startTime?: string;
596
683
  /** The state of the operation. */
597
- state?: string;
684
+ state?:
685
+ | 'OPERATION_STATE_UNSPECIFIED'
686
+ | 'INITIALIZING'
687
+ | 'PROCESSING'
688
+ | 'CANCELLING'
689
+ | 'FINALIZING'
690
+ | 'SUCCESSFUL'
691
+ | 'FAILED'
692
+ | 'CANCELLED';
598
693
  }
599
694
  interface GoogleFirestoreAdminV1ListBackupSchedulesResponse {
600
695
  /** List of all backup schedules. */
@@ -656,7 +751,15 @@ declare namespace gapi.client {
656
751
  /** The time the restore finished, unset for ongoing restores. */
657
752
  endTime?: string;
658
753
  /** The operation state of the restore. */
659
- operationState?: string;
754
+ operationState?:
755
+ | 'OPERATION_STATE_UNSPECIFIED'
756
+ | 'INITIALIZING'
757
+ | 'PROCESSING'
758
+ | 'CANCELLING'
759
+ | 'FINALIZING'
760
+ | 'SUCCESSFUL'
761
+ | 'FAILED'
762
+ | 'CANCELLED';
660
763
  /** How far along the restore is as an estimated percentage of remaining time. */
661
764
  progressPercentage?: GoogleFirestoreAdminV1Progress;
662
765
  /** The time the restore was started. */
@@ -689,11 +792,11 @@ declare namespace gapi.client {
689
792
  }
690
793
  interface GoogleFirestoreAdminV1TtlConfig {
691
794
  /** Output only. The state of the TTL configuration. */
692
- state?: string;
795
+ state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'NEEDS_REPAIR';
693
796
  }
694
797
  interface GoogleFirestoreAdminV1TtlConfigDelta {
695
798
  /** Specifies how the TTL configuration is changing. */
696
- changeType?: string;
799
+ changeType?: 'CHANGE_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE';
697
800
  }
698
801
  interface GoogleFirestoreAdminV1UpdateDatabaseMetadata {}
699
802
  interface GoogleFirestoreAdminV1UserCreds {
@@ -706,7 +809,7 @@ declare namespace gapi.client {
706
809
  /** Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword. */
707
810
  securePassword?: string;
708
811
  /** Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation. */
709
- state?: string;
812
+ state?: 'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED';
710
813
  /** Output only. The time the user creds were last updated. */
711
814
  updateTime?: string;
712
815
  }
@@ -718,7 +821,15 @@ declare namespace gapi.client {
718
821
  }
719
822
  interface GoogleFirestoreAdminV1WeeklyRecurrence {
720
823
  /** The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. */
721
- day?: string;
824
+ day?:
825
+ | 'DAY_OF_WEEK_UNSPECIFIED'
826
+ | 'MONDAY'
827
+ | 'TUESDAY'
828
+ | 'WEDNESDAY'
829
+ | 'THURSDAY'
830
+ | 'FRIDAY'
831
+ | 'SATURDAY'
832
+ | 'SUNDAY';
722
833
  }
723
834
  interface GoogleLongrunningCancelOperationRequest {}
724
835
  interface GoogleLongrunningListOperationsResponse {
@@ -811,7 +922,7 @@ declare namespace gapi.client {
811
922
  }
812
923
  interface Order {
813
924
  /** The direction to order by. Defaults to `ASCENDING`. */
814
- direction?: string;
925
+ direction?: 'DIRECTION_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
815
926
  /** The field to order by. */
816
927
  field?: FieldReference;
817
928
  }
@@ -993,7 +1104,7 @@ declare namespace gapi.client {
993
1104
  /** A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change. */
994
1105
  resumeToken?: string;
995
1106
  /** The type of change that occurred. */
996
- targetChangeType?: string;
1107
+ targetChangeType?: 'NO_CHANGE' | 'ADD' | 'REMOVE' | 'CURRENT' | 'RESET';
997
1108
  /** The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined. */
998
1109
  targetIds?: number[];
999
1110
  }
@@ -1007,7 +1118,12 @@ declare namespace gapi.client {
1007
1118
  /** The field to which to apply the operator. */
1008
1119
  field?: FieldReference;
1009
1120
  /** The unary operator to apply. */
1010
- op?: string;
1121
+ op?:
1122
+ | 'OPERATOR_UNSPECIFIED'
1123
+ | 'IS_NAN'
1124
+ | 'IS_NULL'
1125
+ | 'IS_NOT_NAN'
1126
+ | 'IS_NOT_NULL';
1011
1127
  }
1012
1128
  interface Value {
1013
1129
  /** An array value. Cannot directly contain another array value, though can contain a map which contains another array. */
@@ -1029,7 +1145,7 @@ declare namespace gapi.client {
1029
1145
  /** A map value. */
1030
1146
  mapValue?: MapValue;
1031
1147
  /** A null value. */
1032
- nullValue?: string;
1148
+ nullValue?: 'NULL_VALUE';
1033
1149
  /** A value that represents an unevaluated pipeline. **Requires:** * Not allowed to be used when writing documents. */
1034
1150
  pipelineValue?: Pipeline;
1035
1151
  /** A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. */
@@ -1085,11 +1201,11 @@ declare namespace gapi.client {
1085
1201
  /** Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule. */
1086
1202
  create(request: {
1087
1203
  /** V1 error format. */
1088
- '$.xgafv'?: string;
1204
+ '$.xgafv'?: '1' | '2';
1089
1205
  /** OAuth access token. */
1090
1206
  access_token?: string;
1091
1207
  /** Data format for response. */
1092
- alt?: string;
1208
+ alt?: 'json' | 'media' | 'proto';
1093
1209
  /** JSONP */
1094
1210
  callback?: string;
1095
1211
  /** Selector specifying which fields to include in a partial response. */
@@ -1114,11 +1230,11 @@ declare namespace gapi.client {
1114
1230
  create(
1115
1231
  request: {
1116
1232
  /** V1 error format. */
1117
- '$.xgafv'?: string;
1233
+ '$.xgafv'?: '1' | '2';
1118
1234
  /** OAuth access token. */
1119
1235
  access_token?: string;
1120
1236
  /** Data format for response. */
1121
- alt?: string;
1237
+ alt?: 'json' | 'media' | 'proto';
1122
1238
  /** JSONP */
1123
1239
  callback?: string;
1124
1240
  /** Selector specifying which fields to include in a partial response. */
@@ -1143,11 +1259,11 @@ declare namespace gapi.client {
1143
1259
  /** Deletes a backup schedule. */
1144
1260
  delete(request?: {
1145
1261
  /** V1 error format. */
1146
- '$.xgafv'?: string;
1262
+ '$.xgafv'?: '1' | '2';
1147
1263
  /** OAuth access token. */
1148
1264
  access_token?: string;
1149
1265
  /** Data format for response. */
1150
- alt?: string;
1266
+ alt?: 'json' | 'media' | 'proto';
1151
1267
  /** JSONP */
1152
1268
  callback?: string;
1153
1269
  /** Selector specifying which fields to include in a partial response. */
@@ -1170,11 +1286,11 @@ declare namespace gapi.client {
1170
1286
  /** Gets information about a backup schedule. */
1171
1287
  get(request?: {
1172
1288
  /** V1 error format. */
1173
- '$.xgafv'?: string;
1289
+ '$.xgafv'?: '1' | '2';
1174
1290
  /** OAuth access token. */
1175
1291
  access_token?: string;
1176
1292
  /** Data format for response. */
1177
- alt?: string;
1293
+ alt?: 'json' | 'media' | 'proto';
1178
1294
  /** JSONP */
1179
1295
  callback?: string;
1180
1296
  /** Selector specifying which fields to include in a partial response. */
@@ -1197,11 +1313,11 @@ declare namespace gapi.client {
1197
1313
  /** List backup schedules. */
1198
1314
  list(request?: {
1199
1315
  /** V1 error format. */
1200
- '$.xgafv'?: string;
1316
+ '$.xgafv'?: '1' | '2';
1201
1317
  /** OAuth access token. */
1202
1318
  access_token?: string;
1203
1319
  /** Data format for response. */
1204
- alt?: string;
1320
+ alt?: 'json' | 'media' | 'proto';
1205
1321
  /** JSONP */
1206
1322
  callback?: string;
1207
1323
  /** Selector specifying which fields to include in a partial response. */
@@ -1224,11 +1340,11 @@ declare namespace gapi.client {
1224
1340
  /** Updates a backup schedule. */
1225
1341
  patch(request: {
1226
1342
  /** V1 error format. */
1227
- '$.xgafv'?: string;
1343
+ '$.xgafv'?: '1' | '2';
1228
1344
  /** OAuth access token. */
1229
1345
  access_token?: string;
1230
1346
  /** Data format for response. */
1231
- alt?: string;
1347
+ alt?: 'json' | 'media' | 'proto';
1232
1348
  /** JSONP */
1233
1349
  callback?: string;
1234
1350
  /** Selector specifying which fields to include in a partial response. */
@@ -1255,11 +1371,11 @@ declare namespace gapi.client {
1255
1371
  patch(
1256
1372
  request: {
1257
1373
  /** V1 error format. */
1258
- '$.xgafv'?: string;
1374
+ '$.xgafv'?: '1' | '2';
1259
1375
  /** OAuth access token. */
1260
1376
  access_token?: string;
1261
1377
  /** Data format for response. */
1262
- alt?: string;
1378
+ alt?: 'json' | 'media' | 'proto';
1263
1379
  /** JSONP */
1264
1380
  callback?: string;
1265
1381
  /** Selector specifying which fields to include in a partial response. */
@@ -1288,11 +1404,11 @@ declare namespace gapi.client {
1288
1404
  /** Gets the metadata and configuration for a Field. */
1289
1405
  get(request?: {
1290
1406
  /** V1 error format. */
1291
- '$.xgafv'?: string;
1407
+ '$.xgafv'?: '1' | '2';
1292
1408
  /** OAuth access token. */
1293
1409
  access_token?: string;
1294
1410
  /** Data format for response. */
1295
- alt?: string;
1411
+ alt?: 'json' | 'media' | 'proto';
1296
1412
  /** JSONP */
1297
1413
  callback?: string;
1298
1414
  /** Selector specifying which fields to include in a partial response. */
@@ -1315,11 +1431,11 @@ declare namespace gapi.client {
1315
1431
  /** Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. */
1316
1432
  list(request?: {
1317
1433
  /** V1 error format. */
1318
- '$.xgafv'?: string;
1434
+ '$.xgafv'?: '1' | '2';
1319
1435
  /** OAuth access token. */
1320
1436
  access_token?: string;
1321
1437
  /** Data format for response. */
1322
- alt?: string;
1438
+ alt?: 'json' | 'media' | 'proto';
1323
1439
  /** JSONP */
1324
1440
  callback?: string;
1325
1441
  /** Selector specifying which fields to include in a partial response. */
@@ -1348,11 +1464,11 @@ declare namespace gapi.client {
1348
1464
  /** Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. */
1349
1465
  patch(request: {
1350
1466
  /** V1 error format. */
1351
- '$.xgafv'?: string;
1467
+ '$.xgafv'?: '1' | '2';
1352
1468
  /** OAuth access token. */
1353
1469
  access_token?: string;
1354
1470
  /** Data format for response. */
1355
- alt?: string;
1471
+ alt?: 'json' | 'media' | 'proto';
1356
1472
  /** JSONP */
1357
1473
  callback?: string;
1358
1474
  /** Selector specifying which fields to include in a partial response. */
@@ -1379,11 +1495,11 @@ declare namespace gapi.client {
1379
1495
  patch(
1380
1496
  request: {
1381
1497
  /** V1 error format. */
1382
- '$.xgafv'?: string;
1498
+ '$.xgafv'?: '1' | '2';
1383
1499
  /** OAuth access token. */
1384
1500
  access_token?: string;
1385
1501
  /** Data format for response. */
1386
- alt?: string;
1502
+ alt?: 'json' | 'media' | 'proto';
1387
1503
  /** JSONP */
1388
1504
  callback?: string;
1389
1505
  /** Selector specifying which fields to include in a partial response. */
@@ -1412,11 +1528,11 @@ declare namespace gapi.client {
1412
1528
  /** Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. */
1413
1529
  create(request: {
1414
1530
  /** V1 error format. */
1415
- '$.xgafv'?: string;
1531
+ '$.xgafv'?: '1' | '2';
1416
1532
  /** OAuth access token. */
1417
1533
  access_token?: string;
1418
1534
  /** Data format for response. */
1419
- alt?: string;
1535
+ alt?: 'json' | 'media' | 'proto';
1420
1536
  /** JSONP */
1421
1537
  callback?: string;
1422
1538
  /** Selector specifying which fields to include in a partial response. */
@@ -1441,11 +1557,11 @@ declare namespace gapi.client {
1441
1557
  create(
1442
1558
  request: {
1443
1559
  /** V1 error format. */
1444
- '$.xgafv'?: string;
1560
+ '$.xgafv'?: '1' | '2';
1445
1561
  /** OAuth access token. */
1446
1562
  access_token?: string;
1447
1563
  /** Data format for response. */
1448
- alt?: string;
1564
+ alt?: 'json' | 'media' | 'proto';
1449
1565
  /** JSONP */
1450
1566
  callback?: string;
1451
1567
  /** Selector specifying which fields to include in a partial response. */
@@ -1470,11 +1586,11 @@ declare namespace gapi.client {
1470
1586
  /** Deletes a composite index. */
1471
1587
  delete(request?: {
1472
1588
  /** V1 error format. */
1473
- '$.xgafv'?: string;
1589
+ '$.xgafv'?: '1' | '2';
1474
1590
  /** OAuth access token. */
1475
1591
  access_token?: string;
1476
1592
  /** Data format for response. */
1477
- alt?: string;
1593
+ alt?: 'json' | 'media' | 'proto';
1478
1594
  /** JSONP */
1479
1595
  callback?: string;
1480
1596
  /** Selector specifying which fields to include in a partial response. */
@@ -1497,11 +1613,11 @@ declare namespace gapi.client {
1497
1613
  /** Gets a composite index. */
1498
1614
  get(request?: {
1499
1615
  /** V1 error format. */
1500
- '$.xgafv'?: string;
1616
+ '$.xgafv'?: '1' | '2';
1501
1617
  /** OAuth access token. */
1502
1618
  access_token?: string;
1503
1619
  /** Data format for response. */
1504
- alt?: string;
1620
+ alt?: 'json' | 'media' | 'proto';
1505
1621
  /** JSONP */
1506
1622
  callback?: string;
1507
1623
  /** Selector specifying which fields to include in a partial response. */
@@ -1524,11 +1640,11 @@ declare namespace gapi.client {
1524
1640
  /** Lists composite indexes. */
1525
1641
  list(request?: {
1526
1642
  /** V1 error format. */
1527
- '$.xgafv'?: string;
1643
+ '$.xgafv'?: '1' | '2';
1528
1644
  /** OAuth access token. */
1529
1645
  access_token?: string;
1530
1646
  /** Data format for response. */
1531
- alt?: string;
1647
+ alt?: 'json' | 'media' | 'proto';
1532
1648
  /** JSONP */
1533
1649
  callback?: string;
1534
1650
  /** Selector specifying which fields to include in a partial response. */
@@ -1563,11 +1679,11 @@ declare namespace gapi.client {
1563
1679
  /** Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. */
1564
1680
  batchGet(request: {
1565
1681
  /** V1 error format. */
1566
- '$.xgafv'?: string;
1682
+ '$.xgafv'?: '1' | '2';
1567
1683
  /** OAuth access token. */
1568
1684
  access_token?: string;
1569
1685
  /** Data format for response. */
1570
- alt?: string;
1686
+ alt?: 'json' | 'media' | 'proto';
1571
1687
  /** JSONP */
1572
1688
  callback?: string;
1573
1689
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1592,11 +1708,11 @@ declare namespace gapi.client {
1592
1708
  batchGet(
1593
1709
  request: {
1594
1710
  /** V1 error format. */
1595
- '$.xgafv'?: string;
1711
+ '$.xgafv'?: '1' | '2';
1596
1712
  /** OAuth access token. */
1597
1713
  access_token?: string;
1598
1714
  /** Data format for response. */
1599
- alt?: string;
1715
+ alt?: 'json' | 'media' | 'proto';
1600
1716
  /** JSONP */
1601
1717
  callback?: string;
1602
1718
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1621,11 +1737,11 @@ declare namespace gapi.client {
1621
1737
  /** Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead. */
1622
1738
  batchWrite(request: {
1623
1739
  /** V1 error format. */
1624
- '$.xgafv'?: string;
1740
+ '$.xgafv'?: '1' | '2';
1625
1741
  /** OAuth access token. */
1626
1742
  access_token?: string;
1627
1743
  /** Data format for response. */
1628
- alt?: string;
1744
+ alt?: 'json' | 'media' | 'proto';
1629
1745
  /** JSONP */
1630
1746
  callback?: string;
1631
1747
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1650,11 +1766,11 @@ declare namespace gapi.client {
1650
1766
  batchWrite(
1651
1767
  request: {
1652
1768
  /** V1 error format. */
1653
- '$.xgafv'?: string;
1769
+ '$.xgafv'?: '1' | '2';
1654
1770
  /** OAuth access token. */
1655
1771
  access_token?: string;
1656
1772
  /** Data format for response. */
1657
- alt?: string;
1773
+ alt?: 'json' | 'media' | 'proto';
1658
1774
  /** JSONP */
1659
1775
  callback?: string;
1660
1776
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1679,11 +1795,11 @@ declare namespace gapi.client {
1679
1795
  /** Starts a new transaction. */
1680
1796
  beginTransaction(request: {
1681
1797
  /** V1 error format. */
1682
- '$.xgafv'?: string;
1798
+ '$.xgafv'?: '1' | '2';
1683
1799
  /** OAuth access token. */
1684
1800
  access_token?: string;
1685
1801
  /** Data format for response. */
1686
- alt?: string;
1802
+ alt?: 'json' | 'media' | 'proto';
1687
1803
  /** JSONP */
1688
1804
  callback?: string;
1689
1805
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1708,11 +1824,11 @@ declare namespace gapi.client {
1708
1824
  beginTransaction(
1709
1825
  request: {
1710
1826
  /** V1 error format. */
1711
- '$.xgafv'?: string;
1827
+ '$.xgafv'?: '1' | '2';
1712
1828
  /** OAuth access token. */
1713
1829
  access_token?: string;
1714
1830
  /** Data format for response. */
1715
- alt?: string;
1831
+ alt?: 'json' | 'media' | 'proto';
1716
1832
  /** JSONP */
1717
1833
  callback?: string;
1718
1834
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1737,11 +1853,11 @@ declare namespace gapi.client {
1737
1853
  /** Commits a transaction, while optionally updating documents. */
1738
1854
  commit(request: {
1739
1855
  /** V1 error format. */
1740
- '$.xgafv'?: string;
1856
+ '$.xgafv'?: '1' | '2';
1741
1857
  /** OAuth access token. */
1742
1858
  access_token?: string;
1743
1859
  /** Data format for response. */
1744
- alt?: string;
1860
+ alt?: 'json' | 'media' | 'proto';
1745
1861
  /** JSONP */
1746
1862
  callback?: string;
1747
1863
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1766,11 +1882,11 @@ declare namespace gapi.client {
1766
1882
  commit(
1767
1883
  request: {
1768
1884
  /** V1 error format. */
1769
- '$.xgafv'?: string;
1885
+ '$.xgafv'?: '1' | '2';
1770
1886
  /** OAuth access token. */
1771
1887
  access_token?: string;
1772
1888
  /** Data format for response. */
1773
- alt?: string;
1889
+ alt?: 'json' | 'media' | 'proto';
1774
1890
  /** JSONP */
1775
1891
  callback?: string;
1776
1892
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -1795,11 +1911,11 @@ declare namespace gapi.client {
1795
1911
  /** Creates a new document. */
1796
1912
  createDocument(request: {
1797
1913
  /** V1 error format. */
1798
- '$.xgafv'?: string;
1914
+ '$.xgafv'?: '1' | '2';
1799
1915
  /** OAuth access token. */
1800
1916
  access_token?: string;
1801
1917
  /** Data format for response. */
1802
- alt?: string;
1918
+ alt?: 'json' | 'media' | 'proto';
1803
1919
  /** JSONP */
1804
1920
  callback?: string;
1805
1921
  /** Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. */
@@ -1830,11 +1946,11 @@ declare namespace gapi.client {
1830
1946
  createDocument(
1831
1947
  request: {
1832
1948
  /** V1 error format. */
1833
- '$.xgafv'?: string;
1949
+ '$.xgafv'?: '1' | '2';
1834
1950
  /** OAuth access token. */
1835
1951
  access_token?: string;
1836
1952
  /** Data format for response. */
1837
- alt?: string;
1953
+ alt?: 'json' | 'media' | 'proto';
1838
1954
  /** JSONP */
1839
1955
  callback?: string;
1840
1956
  /** Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. */
@@ -1865,11 +1981,11 @@ declare namespace gapi.client {
1865
1981
  /** Deletes a document. */
1866
1982
  delete(request?: {
1867
1983
  /** V1 error format. */
1868
- '$.xgafv'?: string;
1984
+ '$.xgafv'?: '1' | '2';
1869
1985
  /** OAuth access token. */
1870
1986
  access_token?: string;
1871
1987
  /** Data format for response. */
1872
- alt?: string;
1988
+ alt?: 'json' | 'media' | 'proto';
1873
1989
  /** JSONP */
1874
1990
  callback?: string;
1875
1991
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -1896,11 +2012,11 @@ declare namespace gapi.client {
1896
2012
  /** Executes a pipeline query. */
1897
2013
  executePipeline(request: {
1898
2014
  /** V1 error format. */
1899
- '$.xgafv'?: string;
2015
+ '$.xgafv'?: '1' | '2';
1900
2016
  /** OAuth access token. */
1901
2017
  access_token?: string;
1902
2018
  /** Data format for response. */
1903
- alt?: string;
2019
+ alt?: 'json' | 'media' | 'proto';
1904
2020
  /** JSONP */
1905
2021
  callback?: string;
1906
2022
  /** Required. Database identifier, in the form `projects/{project}/databases/{database}`. */
@@ -1925,11 +2041,11 @@ declare namespace gapi.client {
1925
2041
  executePipeline(
1926
2042
  request: {
1927
2043
  /** V1 error format. */
1928
- '$.xgafv'?: string;
2044
+ '$.xgafv'?: '1' | '2';
1929
2045
  /** OAuth access token. */
1930
2046
  access_token?: string;
1931
2047
  /** Data format for response. */
1932
- alt?: string;
2048
+ alt?: 'json' | 'media' | 'proto';
1933
2049
  /** JSONP */
1934
2050
  callback?: string;
1935
2051
  /** Required. Database identifier, in the form `projects/{project}/databases/{database}`. */
@@ -1954,11 +2070,11 @@ declare namespace gapi.client {
1954
2070
  /** Gets a single document. */
1955
2071
  get(request?: {
1956
2072
  /** V1 error format. */
1957
- '$.xgafv'?: string;
2073
+ '$.xgafv'?: '1' | '2';
1958
2074
  /** OAuth access token. */
1959
2075
  access_token?: string;
1960
2076
  /** Data format for response. */
1961
- alt?: string;
2077
+ alt?: 'json' | 'media' | 'proto';
1962
2078
  /** JSONP */
1963
2079
  callback?: string;
1964
2080
  /** Selector specifying which fields to include in a partial response. */
@@ -1987,11 +2103,11 @@ declare namespace gapi.client {
1987
2103
  /** Lists documents. */
1988
2104
  list(request?: {
1989
2105
  /** V1 error format. */
1990
- '$.xgafv'?: string;
2106
+ '$.xgafv'?: '1' | '2';
1991
2107
  /** OAuth access token. */
1992
2108
  access_token?: string;
1993
2109
  /** Data format for response. */
1994
- alt?: string;
2110
+ alt?: 'json' | 'media' | 'proto';
1995
2111
  /** JSONP */
1996
2112
  callback?: string;
1997
2113
  /** Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. */
@@ -2030,11 +2146,11 @@ declare namespace gapi.client {
2030
2146
  /** Lists all the collection IDs underneath a document. */
2031
2147
  listCollectionIds(request: {
2032
2148
  /** V1 error format. */
2033
- '$.xgafv'?: string;
2149
+ '$.xgafv'?: '1' | '2';
2034
2150
  /** OAuth access token. */
2035
2151
  access_token?: string;
2036
2152
  /** Data format for response. */
2037
- alt?: string;
2153
+ alt?: 'json' | 'media' | 'proto';
2038
2154
  /** JSONP */
2039
2155
  callback?: string;
2040
2156
  /** Selector specifying which fields to include in a partial response. */
@@ -2059,11 +2175,11 @@ declare namespace gapi.client {
2059
2175
  listCollectionIds(
2060
2176
  request: {
2061
2177
  /** V1 error format. */
2062
- '$.xgafv'?: string;
2178
+ '$.xgafv'?: '1' | '2';
2063
2179
  /** OAuth access token. */
2064
2180
  access_token?: string;
2065
2181
  /** Data format for response. */
2066
- alt?: string;
2182
+ alt?: 'json' | 'media' | 'proto';
2067
2183
  /** JSONP */
2068
2184
  callback?: string;
2069
2185
  /** Selector specifying which fields to include in a partial response. */
@@ -2088,11 +2204,11 @@ declare namespace gapi.client {
2088
2204
  /** Lists documents. */
2089
2205
  listDocuments(request?: {
2090
2206
  /** V1 error format. */
2091
- '$.xgafv'?: string;
2207
+ '$.xgafv'?: '1' | '2';
2092
2208
  /** OAuth access token. */
2093
2209
  access_token?: string;
2094
2210
  /** Data format for response. */
2095
- alt?: string;
2211
+ alt?: 'json' | 'media' | 'proto';
2096
2212
  /** JSONP */
2097
2213
  callback?: string;
2098
2214
  /** Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. */
@@ -2131,11 +2247,11 @@ declare namespace gapi.client {
2131
2247
  /** Listens to changes. This method is only available via gRPC or WebChannel (not REST). */
2132
2248
  listen(request: {
2133
2249
  /** V1 error format. */
2134
- '$.xgafv'?: string;
2250
+ '$.xgafv'?: '1' | '2';
2135
2251
  /** OAuth access token. */
2136
2252
  access_token?: string;
2137
2253
  /** Data format for response. */
2138
- alt?: string;
2254
+ alt?: 'json' | 'media' | 'proto';
2139
2255
  /** JSONP */
2140
2256
  callback?: string;
2141
2257
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2160,11 +2276,11 @@ declare namespace gapi.client {
2160
2276
  listen(
2161
2277
  request: {
2162
2278
  /** V1 error format. */
2163
- '$.xgafv'?: string;
2279
+ '$.xgafv'?: '1' | '2';
2164
2280
  /** OAuth access token. */
2165
2281
  access_token?: string;
2166
2282
  /** Data format for response. */
2167
- alt?: string;
2283
+ alt?: 'json' | 'media' | 'proto';
2168
2284
  /** JSONP */
2169
2285
  callback?: string;
2170
2286
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2189,11 +2305,11 @@ declare namespace gapi.client {
2189
2305
  /** Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results. */
2190
2306
  partitionQuery(request: {
2191
2307
  /** V1 error format. */
2192
- '$.xgafv'?: string;
2308
+ '$.xgafv'?: '1' | '2';
2193
2309
  /** OAuth access token. */
2194
2310
  access_token?: string;
2195
2311
  /** Data format for response. */
2196
- alt?: string;
2312
+ alt?: 'json' | 'media' | 'proto';
2197
2313
  /** JSONP */
2198
2314
  callback?: string;
2199
2315
  /** Selector specifying which fields to include in a partial response. */
@@ -2218,11 +2334,11 @@ declare namespace gapi.client {
2218
2334
  partitionQuery(
2219
2335
  request: {
2220
2336
  /** V1 error format. */
2221
- '$.xgafv'?: string;
2337
+ '$.xgafv'?: '1' | '2';
2222
2338
  /** OAuth access token. */
2223
2339
  access_token?: string;
2224
2340
  /** Data format for response. */
2225
- alt?: string;
2341
+ alt?: 'json' | 'media' | 'proto';
2226
2342
  /** JSONP */
2227
2343
  callback?: string;
2228
2344
  /** Selector specifying which fields to include in a partial response. */
@@ -2247,11 +2363,11 @@ declare namespace gapi.client {
2247
2363
  /** Updates or inserts a document. */
2248
2364
  patch(request: {
2249
2365
  /** V1 error format. */
2250
- '$.xgafv'?: string;
2366
+ '$.xgafv'?: '1' | '2';
2251
2367
  /** OAuth access token. */
2252
2368
  access_token?: string;
2253
2369
  /** Data format for response. */
2254
- alt?: string;
2370
+ alt?: 'json' | 'media' | 'proto';
2255
2371
  /** JSONP */
2256
2372
  callback?: string;
2257
2373
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -2284,11 +2400,11 @@ declare namespace gapi.client {
2284
2400
  patch(
2285
2401
  request: {
2286
2402
  /** V1 error format. */
2287
- '$.xgafv'?: string;
2403
+ '$.xgafv'?: '1' | '2';
2288
2404
  /** OAuth access token. */
2289
2405
  access_token?: string;
2290
2406
  /** Data format for response. */
2291
- alt?: string;
2407
+ alt?: 'json' | 'media' | 'proto';
2292
2408
  /** JSONP */
2293
2409
  callback?: string;
2294
2410
  /** When set to `true`, the target document must exist. When set to `false`, the target document must not exist. */
@@ -2321,11 +2437,11 @@ declare namespace gapi.client {
2321
2437
  /** Rolls back a transaction. */
2322
2438
  rollback(request: {
2323
2439
  /** V1 error format. */
2324
- '$.xgafv'?: string;
2440
+ '$.xgafv'?: '1' | '2';
2325
2441
  /** OAuth access token. */
2326
2442
  access_token?: string;
2327
2443
  /** Data format for response. */
2328
- alt?: string;
2444
+ alt?: 'json' | 'media' | 'proto';
2329
2445
  /** JSONP */
2330
2446
  callback?: string;
2331
2447
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2350,11 +2466,11 @@ declare namespace gapi.client {
2350
2466
  rollback(
2351
2467
  request: {
2352
2468
  /** V1 error format. */
2353
- '$.xgafv'?: string;
2469
+ '$.xgafv'?: '1' | '2';
2354
2470
  /** OAuth access token. */
2355
2471
  access_token?: string;
2356
2472
  /** Data format for response. */
2357
- alt?: string;
2473
+ alt?: 'json' | 'media' | 'proto';
2358
2474
  /** JSONP */
2359
2475
  callback?: string;
2360
2476
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. */
@@ -2379,11 +2495,11 @@ declare namespace gapi.client {
2379
2495
  /** Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ``` */
2380
2496
  runAggregationQuery(request: {
2381
2497
  /** V1 error format. */
2382
- '$.xgafv'?: string;
2498
+ '$.xgafv'?: '1' | '2';
2383
2499
  /** OAuth access token. */
2384
2500
  access_token?: string;
2385
2501
  /** Data format for response. */
2386
- alt?: string;
2502
+ alt?: 'json' | 'media' | 'proto';
2387
2503
  /** JSONP */
2388
2504
  callback?: string;
2389
2505
  /** Selector specifying which fields to include in a partial response. */
@@ -2408,11 +2524,11 @@ declare namespace gapi.client {
2408
2524
  runAggregationQuery(
2409
2525
  request: {
2410
2526
  /** V1 error format. */
2411
- '$.xgafv'?: string;
2527
+ '$.xgafv'?: '1' | '2';
2412
2528
  /** OAuth access token. */
2413
2529
  access_token?: string;
2414
2530
  /** Data format for response. */
2415
- alt?: string;
2531
+ alt?: 'json' | 'media' | 'proto';
2416
2532
  /** JSONP */
2417
2533
  callback?: string;
2418
2534
  /** Selector specifying which fields to include in a partial response. */
@@ -2437,11 +2553,11 @@ declare namespace gapi.client {
2437
2553
  /** Runs a query. */
2438
2554
  runQuery(request: {
2439
2555
  /** V1 error format. */
2440
- '$.xgafv'?: string;
2556
+ '$.xgafv'?: '1' | '2';
2441
2557
  /** OAuth access token. */
2442
2558
  access_token?: string;
2443
2559
  /** Data format for response. */
2444
- alt?: string;
2560
+ alt?: 'json' | 'media' | 'proto';
2445
2561
  /** JSONP */
2446
2562
  callback?: string;
2447
2563
  /** Selector specifying which fields to include in a partial response. */
@@ -2466,11 +2582,11 @@ declare namespace gapi.client {
2466
2582
  runQuery(
2467
2583
  request: {
2468
2584
  /** V1 error format. */
2469
- '$.xgafv'?: string;
2585
+ '$.xgafv'?: '1' | '2';
2470
2586
  /** OAuth access token. */
2471
2587
  access_token?: string;
2472
2588
  /** Data format for response. */
2473
- alt?: string;
2589
+ alt?: 'json' | 'media' | 'proto';
2474
2590
  /** JSONP */
2475
2591
  callback?: string;
2476
2592
  /** Selector specifying which fields to include in a partial response. */
@@ -2495,11 +2611,11 @@ declare namespace gapi.client {
2495
2611
  /** Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST). */
2496
2612
  write(request: {
2497
2613
  /** V1 error format. */
2498
- '$.xgafv'?: string;
2614
+ '$.xgafv'?: '1' | '2';
2499
2615
  /** OAuth access token. */
2500
2616
  access_token?: string;
2501
2617
  /** Data format for response. */
2502
- alt?: string;
2618
+ alt?: 'json' | 'media' | 'proto';
2503
2619
  /** JSONP */
2504
2620
  callback?: string;
2505
2621
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */
@@ -2524,11 +2640,11 @@ declare namespace gapi.client {
2524
2640
  write(
2525
2641
  request: {
2526
2642
  /** V1 error format. */
2527
- '$.xgafv'?: string;
2643
+ '$.xgafv'?: '1' | '2';
2528
2644
  /** OAuth access token. */
2529
2645
  access_token?: string;
2530
2646
  /** Data format for response. */
2531
- alt?: string;
2647
+ alt?: 'json' | 'media' | 'proto';
2532
2648
  /** JSONP */
2533
2649
  callback?: string;
2534
2650
  /** Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. */
@@ -2555,11 +2671,11 @@ declare namespace gapi.client {
2555
2671
  /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
2556
2672
  cancel(request: {
2557
2673
  /** V1 error format. */
2558
- '$.xgafv'?: string;
2674
+ '$.xgafv'?: '1' | '2';
2559
2675
  /** OAuth access token. */
2560
2676
  access_token?: string;
2561
2677
  /** Data format for response. */
2562
- alt?: string;
2678
+ alt?: 'json' | 'media' | 'proto';
2563
2679
  /** JSONP */
2564
2680
  callback?: string;
2565
2681
  /** Selector specifying which fields to include in a partial response. */
@@ -2584,11 +2700,11 @@ declare namespace gapi.client {
2584
2700
  cancel(
2585
2701
  request: {
2586
2702
  /** V1 error format. */
2587
- '$.xgafv'?: string;
2703
+ '$.xgafv'?: '1' | '2';
2588
2704
  /** OAuth access token. */
2589
2705
  access_token?: string;
2590
2706
  /** Data format for response. */
2591
- alt?: string;
2707
+ alt?: 'json' | 'media' | 'proto';
2592
2708
  /** JSONP */
2593
2709
  callback?: string;
2594
2710
  /** Selector specifying which fields to include in a partial response. */
@@ -2613,11 +2729,11 @@ declare namespace gapi.client {
2613
2729
  /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
2614
2730
  delete(request?: {
2615
2731
  /** V1 error format. */
2616
- '$.xgafv'?: string;
2732
+ '$.xgafv'?: '1' | '2';
2617
2733
  /** OAuth access token. */
2618
2734
  access_token?: string;
2619
2735
  /** Data format for response. */
2620
- alt?: string;
2736
+ alt?: 'json' | 'media' | 'proto';
2621
2737
  /** JSONP */
2622
2738
  callback?: string;
2623
2739
  /** Selector specifying which fields to include in a partial response. */
@@ -2640,11 +2756,11 @@ declare namespace gapi.client {
2640
2756
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
2641
2757
  get(request?: {
2642
2758
  /** V1 error format. */
2643
- '$.xgafv'?: string;
2759
+ '$.xgafv'?: '1' | '2';
2644
2760
  /** OAuth access token. */
2645
2761
  access_token?: string;
2646
2762
  /** Data format for response. */
2647
- alt?: string;
2763
+ alt?: 'json' | 'media' | 'proto';
2648
2764
  /** JSONP */
2649
2765
  callback?: string;
2650
2766
  /** Selector specifying which fields to include in a partial response. */
@@ -2667,11 +2783,11 @@ declare namespace gapi.client {
2667
2783
  /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2668
2784
  list(request?: {
2669
2785
  /** V1 error format. */
2670
- '$.xgafv'?: string;
2786
+ '$.xgafv'?: '1' | '2';
2671
2787
  /** OAuth access token. */
2672
2788
  access_token?: string;
2673
2789
  /** Data format for response. */
2674
- alt?: string;
2790
+ alt?: 'json' | 'media' | 'proto';
2675
2791
  /** JSONP */
2676
2792
  callback?: string;
2677
2793
  /** Selector specifying which fields to include in a partial response. */
@@ -2704,11 +2820,11 @@ declare namespace gapi.client {
2704
2820
  /** Create a user creds. */
2705
2821
  create(request: {
2706
2822
  /** V1 error format. */
2707
- '$.xgafv'?: string;
2823
+ '$.xgafv'?: '1' | '2';
2708
2824
  /** OAuth access token. */
2709
2825
  access_token?: string;
2710
2826
  /** Data format for response. */
2711
- alt?: string;
2827
+ alt?: 'json' | 'media' | 'proto';
2712
2828
  /** JSONP */
2713
2829
  callback?: string;
2714
2830
  /** Selector specifying which fields to include in a partial response. */
@@ -2735,11 +2851,11 @@ declare namespace gapi.client {
2735
2851
  create(
2736
2852
  request: {
2737
2853
  /** V1 error format. */
2738
- '$.xgafv'?: string;
2854
+ '$.xgafv'?: '1' | '2';
2739
2855
  /** OAuth access token. */
2740
2856
  access_token?: string;
2741
2857
  /** Data format for response. */
2742
- alt?: string;
2858
+ alt?: 'json' | 'media' | 'proto';
2743
2859
  /** JSONP */
2744
2860
  callback?: string;
2745
2861
  /** Selector specifying which fields to include in a partial response. */
@@ -2766,11 +2882,11 @@ declare namespace gapi.client {
2766
2882
  /** Deletes a user creds. */
2767
2883
  delete(request?: {
2768
2884
  /** V1 error format. */
2769
- '$.xgafv'?: string;
2885
+ '$.xgafv'?: '1' | '2';
2770
2886
  /** OAuth access token. */
2771
2887
  access_token?: string;
2772
2888
  /** Data format for response. */
2773
- alt?: string;
2889
+ alt?: 'json' | 'media' | 'proto';
2774
2890
  /** JSONP */
2775
2891
  callback?: string;
2776
2892
  /** Selector specifying which fields to include in a partial response. */
@@ -2793,11 +2909,11 @@ declare namespace gapi.client {
2793
2909
  /** Disables a user creds. No-op if the user creds are already disabled. */
2794
2910
  disable(request: {
2795
2911
  /** V1 error format. */
2796
- '$.xgafv'?: string;
2912
+ '$.xgafv'?: '1' | '2';
2797
2913
  /** OAuth access token. */
2798
2914
  access_token?: string;
2799
2915
  /** Data format for response. */
2800
- alt?: string;
2916
+ alt?: 'json' | 'media' | 'proto';
2801
2917
  /** JSONP */
2802
2918
  callback?: string;
2803
2919
  /** Selector specifying which fields to include in a partial response. */
@@ -2822,11 +2938,11 @@ declare namespace gapi.client {
2822
2938
  disable(
2823
2939
  request: {
2824
2940
  /** V1 error format. */
2825
- '$.xgafv'?: string;
2941
+ '$.xgafv'?: '1' | '2';
2826
2942
  /** OAuth access token. */
2827
2943
  access_token?: string;
2828
2944
  /** Data format for response. */
2829
- alt?: string;
2945
+ alt?: 'json' | 'media' | 'proto';
2830
2946
  /** JSONP */
2831
2947
  callback?: string;
2832
2948
  /** Selector specifying which fields to include in a partial response. */
@@ -2851,11 +2967,11 @@ declare namespace gapi.client {
2851
2967
  /** Enables a user creds. No-op if the user creds are already enabled. */
2852
2968
  enable(request: {
2853
2969
  /** V1 error format. */
2854
- '$.xgafv'?: string;
2970
+ '$.xgafv'?: '1' | '2';
2855
2971
  /** OAuth access token. */
2856
2972
  access_token?: string;
2857
2973
  /** Data format for response. */
2858
- alt?: string;
2974
+ alt?: 'json' | 'media' | 'proto';
2859
2975
  /** JSONP */
2860
2976
  callback?: string;
2861
2977
  /** Selector specifying which fields to include in a partial response. */
@@ -2880,11 +2996,11 @@ declare namespace gapi.client {
2880
2996
  enable(
2881
2997
  request: {
2882
2998
  /** V1 error format. */
2883
- '$.xgafv'?: string;
2999
+ '$.xgafv'?: '1' | '2';
2884
3000
  /** OAuth access token. */
2885
3001
  access_token?: string;
2886
3002
  /** Data format for response. */
2887
- alt?: string;
3003
+ alt?: 'json' | 'media' | 'proto';
2888
3004
  /** JSONP */
2889
3005
  callback?: string;
2890
3006
  /** Selector specifying which fields to include in a partial response. */
@@ -2909,11 +3025,11 @@ declare namespace gapi.client {
2909
3025
  /** Gets a user creds resource. Note that the returned resource does not contain the secret value itself. */
2910
3026
  get(request?: {
2911
3027
  /** V1 error format. */
2912
- '$.xgafv'?: string;
3028
+ '$.xgafv'?: '1' | '2';
2913
3029
  /** OAuth access token. */
2914
3030
  access_token?: string;
2915
3031
  /** Data format for response. */
2916
- alt?: string;
3032
+ alt?: 'json' | 'media' | 'proto';
2917
3033
  /** JSONP */
2918
3034
  callback?: string;
2919
3035
  /** Selector specifying which fields to include in a partial response. */
@@ -2936,11 +3052,11 @@ declare namespace gapi.client {
2936
3052
  /** List all user creds in the database. Note that the returned resource does not contain the secret value itself. */
2937
3053
  list(request?: {
2938
3054
  /** V1 error format. */
2939
- '$.xgafv'?: string;
3055
+ '$.xgafv'?: '1' | '2';
2940
3056
  /** OAuth access token. */
2941
3057
  access_token?: string;
2942
3058
  /** Data format for response. */
2943
- alt?: string;
3059
+ alt?: 'json' | 'media' | 'proto';
2944
3060
  /** JSONP */
2945
3061
  callback?: string;
2946
3062
  /** Selector specifying which fields to include in a partial response. */
@@ -2963,11 +3079,11 @@ declare namespace gapi.client {
2963
3079
  /** Resets the password of a user creds. */
2964
3080
  resetPassword(request: {
2965
3081
  /** V1 error format. */
2966
- '$.xgafv'?: string;
3082
+ '$.xgafv'?: '1' | '2';
2967
3083
  /** OAuth access token. */
2968
3084
  access_token?: string;
2969
3085
  /** Data format for response. */
2970
- alt?: string;
3086
+ alt?: 'json' | 'media' | 'proto';
2971
3087
  /** JSONP */
2972
3088
  callback?: string;
2973
3089
  /** Selector specifying which fields to include in a partial response. */
@@ -2992,11 +3108,11 @@ declare namespace gapi.client {
2992
3108
  resetPassword(
2993
3109
  request: {
2994
3110
  /** V1 error format. */
2995
- '$.xgafv'?: string;
3111
+ '$.xgafv'?: '1' | '2';
2996
3112
  /** OAuth access token. */
2997
3113
  access_token?: string;
2998
3114
  /** Data format for response. */
2999
- alt?: string;
3115
+ alt?: 'json' | 'media' | 'proto';
3000
3116
  /** JSONP */
3001
3117
  callback?: string;
3002
3118
  /** Selector specifying which fields to include in a partial response. */
@@ -3023,11 +3139,11 @@ declare namespace gapi.client {
3023
3139
  /** Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete */
3024
3140
  bulkDeleteDocuments(request: {
3025
3141
  /** V1 error format. */
3026
- '$.xgafv'?: string;
3142
+ '$.xgafv'?: '1' | '2';
3027
3143
  /** OAuth access token. */
3028
3144
  access_token?: string;
3029
3145
  /** Data format for response. */
3030
- alt?: string;
3146
+ alt?: 'json' | 'media' | 'proto';
3031
3147
  /** JSONP */
3032
3148
  callback?: string;
3033
3149
  /** Selector specifying which fields to include in a partial response. */
@@ -3052,11 +3168,11 @@ declare namespace gapi.client {
3052
3168
  bulkDeleteDocuments(
3053
3169
  request: {
3054
3170
  /** V1 error format. */
3055
- '$.xgafv'?: string;
3171
+ '$.xgafv'?: '1' | '2';
3056
3172
  /** OAuth access token. */
3057
3173
  access_token?: string;
3058
3174
  /** Data format for response. */
3059
- alt?: string;
3175
+ alt?: 'json' | 'media' | 'proto';
3060
3176
  /** JSONP */
3061
3177
  callback?: string;
3062
3178
  /** Selector specifying which fields to include in a partial response. */
@@ -3081,11 +3197,11 @@ declare namespace gapi.client {
3081
3197
  /** Creates a new database by cloning an existing one. The new database must be in the same cloud region or multi-region location as the existing database. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing database. The long-running operation can be used to track the progress of the clone, with the Operation's metadata field type being the CloneDatabaseMetadata. The response type is the Database if the clone was successful. The new database is not readable or writeable until the LRO has completed. */
3082
3198
  clone(request: {
3083
3199
  /** V1 error format. */
3084
- '$.xgafv'?: string;
3200
+ '$.xgafv'?: '1' | '2';
3085
3201
  /** OAuth access token. */
3086
3202
  access_token?: string;
3087
3203
  /** Data format for response. */
3088
- alt?: string;
3204
+ alt?: 'json' | 'media' | 'proto';
3089
3205
  /** JSONP */
3090
3206
  callback?: string;
3091
3207
  /** Selector specifying which fields to include in a partial response. */
@@ -3110,11 +3226,11 @@ declare namespace gapi.client {
3110
3226
  clone(
3111
3227
  request: {
3112
3228
  /** V1 error format. */
3113
- '$.xgafv'?: string;
3229
+ '$.xgafv'?: '1' | '2';
3114
3230
  /** OAuth access token. */
3115
3231
  access_token?: string;
3116
3232
  /** Data format for response. */
3117
- alt?: string;
3233
+ alt?: 'json' | 'media' | 'proto';
3118
3234
  /** JSONP */
3119
3235
  callback?: string;
3120
3236
  /** Selector specifying which fields to include in a partial response. */
@@ -3139,11 +3255,11 @@ declare namespace gapi.client {
3139
3255
  /** Create a database. */
3140
3256
  create(request: {
3141
3257
  /** V1 error format. */
3142
- '$.xgafv'?: string;
3258
+ '$.xgafv'?: '1' | '2';
3143
3259
  /** OAuth access token. */
3144
3260
  access_token?: string;
3145
3261
  /** Data format for response. */
3146
- alt?: string;
3262
+ alt?: 'json' | 'media' | 'proto';
3147
3263
  /** JSONP */
3148
3264
  callback?: string;
3149
3265
  /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. */
@@ -3170,11 +3286,11 @@ declare namespace gapi.client {
3170
3286
  create(
3171
3287
  request: {
3172
3288
  /** V1 error format. */
3173
- '$.xgafv'?: string;
3289
+ '$.xgafv'?: '1' | '2';
3174
3290
  /** OAuth access token. */
3175
3291
  access_token?: string;
3176
3292
  /** Data format for response. */
3177
- alt?: string;
3293
+ alt?: 'json' | 'media' | 'proto';
3178
3294
  /** JSONP */
3179
3295
  callback?: string;
3180
3296
  /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid if the database is Standard edition. */
@@ -3201,11 +3317,11 @@ declare namespace gapi.client {
3201
3317
  /** Deletes a database. */
3202
3318
  delete(request?: {
3203
3319
  /** V1 error format. */
3204
- '$.xgafv'?: string;
3320
+ '$.xgafv'?: '1' | '2';
3205
3321
  /** OAuth access token. */
3206
3322
  access_token?: string;
3207
3323
  /** Data format for response. */
3208
- alt?: string;
3324
+ alt?: 'json' | 'media' | 'proto';
3209
3325
  /** JSONP */
3210
3326
  callback?: string;
3211
3327
  /** The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned. */
@@ -3230,11 +3346,11 @@ declare namespace gapi.client {
3230
3346
  /** Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import */
3231
3347
  exportDocuments(request: {
3232
3348
  /** V1 error format. */
3233
- '$.xgafv'?: string;
3349
+ '$.xgafv'?: '1' | '2';
3234
3350
  /** OAuth access token. */
3235
3351
  access_token?: string;
3236
3352
  /** Data format for response. */
3237
- alt?: string;
3353
+ alt?: 'json' | 'media' | 'proto';
3238
3354
  /** JSONP */
3239
3355
  callback?: string;
3240
3356
  /** Selector specifying which fields to include in a partial response. */
@@ -3259,11 +3375,11 @@ declare namespace gapi.client {
3259
3375
  exportDocuments(
3260
3376
  request: {
3261
3377
  /** V1 error format. */
3262
- '$.xgafv'?: string;
3378
+ '$.xgafv'?: '1' | '2';
3263
3379
  /** OAuth access token. */
3264
3380
  access_token?: string;
3265
3381
  /** Data format for response. */
3266
- alt?: string;
3382
+ alt?: 'json' | 'media' | 'proto';
3267
3383
  /** JSONP */
3268
3384
  callback?: string;
3269
3385
  /** Selector specifying which fields to include in a partial response. */
@@ -3288,11 +3404,11 @@ declare namespace gapi.client {
3288
3404
  /** Gets information about a database. */
3289
3405
  get(request?: {
3290
3406
  /** V1 error format. */
3291
- '$.xgafv'?: string;
3407
+ '$.xgafv'?: '1' | '2';
3292
3408
  /** OAuth access token. */
3293
3409
  access_token?: string;
3294
3410
  /** Data format for response. */
3295
- alt?: string;
3411
+ alt?: 'json' | 'media' | 'proto';
3296
3412
  /** JSONP */
3297
3413
  callback?: string;
3298
3414
  /** Selector specifying which fields to include in a partial response. */
@@ -3315,11 +3431,11 @@ declare namespace gapi.client {
3315
3431
  /** Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore. */
3316
3432
  importDocuments(request: {
3317
3433
  /** V1 error format. */
3318
- '$.xgafv'?: string;
3434
+ '$.xgafv'?: '1' | '2';
3319
3435
  /** OAuth access token. */
3320
3436
  access_token?: string;
3321
3437
  /** Data format for response. */
3322
- alt?: string;
3438
+ alt?: 'json' | 'media' | 'proto';
3323
3439
  /** JSONP */
3324
3440
  callback?: string;
3325
3441
  /** Selector specifying which fields to include in a partial response. */
@@ -3344,11 +3460,11 @@ declare namespace gapi.client {
3344
3460
  importDocuments(
3345
3461
  request: {
3346
3462
  /** V1 error format. */
3347
- '$.xgafv'?: string;
3463
+ '$.xgafv'?: '1' | '2';
3348
3464
  /** OAuth access token. */
3349
3465
  access_token?: string;
3350
3466
  /** Data format for response. */
3351
- alt?: string;
3467
+ alt?: 'json' | 'media' | 'proto';
3352
3468
  /** JSONP */
3353
3469
  callback?: string;
3354
3470
  /** Selector specifying which fields to include in a partial response. */
@@ -3373,11 +3489,11 @@ declare namespace gapi.client {
3373
3489
  /** List all the databases in the project. */
3374
3490
  list(request?: {
3375
3491
  /** V1 error format. */
3376
- '$.xgafv'?: string;
3492
+ '$.xgafv'?: '1' | '2';
3377
3493
  /** OAuth access token. */
3378
3494
  access_token?: string;
3379
3495
  /** Data format for response. */
3380
- alt?: string;
3496
+ alt?: 'json' | 'media' | 'proto';
3381
3497
  /** JSONP */
3382
3498
  callback?: string;
3383
3499
  /** Selector specifying which fields to include in a partial response. */
@@ -3402,11 +3518,11 @@ declare namespace gapi.client {
3402
3518
  /** Updates a database. */
3403
3519
  patch(request: {
3404
3520
  /** V1 error format. */
3405
- '$.xgafv'?: string;
3521
+ '$.xgafv'?: '1' | '2';
3406
3522
  /** OAuth access token. */
3407
3523
  access_token?: string;
3408
3524
  /** Data format for response. */
3409
- alt?: string;
3525
+ alt?: 'json' | 'media' | 'proto';
3410
3526
  /** JSONP */
3411
3527
  callback?: string;
3412
3528
  /** Selector specifying which fields to include in a partial response. */
@@ -3433,11 +3549,11 @@ declare namespace gapi.client {
3433
3549
  patch(
3434
3550
  request: {
3435
3551
  /** V1 error format. */
3436
- '$.xgafv'?: string;
3552
+ '$.xgafv'?: '1' | '2';
3437
3553
  /** OAuth access token. */
3438
3554
  access_token?: string;
3439
3555
  /** Data format for response. */
3440
- alt?: string;
3556
+ alt?: 'json' | 'media' | 'proto';
3441
3557
  /** JSONP */
3442
3558
  callback?: string;
3443
3559
  /** Selector specifying which fields to include in a partial response. */
@@ -3464,11 +3580,11 @@ declare namespace gapi.client {
3464
3580
  /** Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed. */
3465
3581
  restore(request: {
3466
3582
  /** V1 error format. */
3467
- '$.xgafv'?: string;
3583
+ '$.xgafv'?: '1' | '2';
3468
3584
  /** OAuth access token. */
3469
3585
  access_token?: string;
3470
3586
  /** Data format for response. */
3471
- alt?: string;
3587
+ alt?: 'json' | 'media' | 'proto';
3472
3588
  /** JSONP */
3473
3589
  callback?: string;
3474
3590
  /** Selector specifying which fields to include in a partial response. */
@@ -3493,11 +3609,11 @@ declare namespace gapi.client {
3493
3609
  restore(
3494
3610
  request: {
3495
3611
  /** V1 error format. */
3496
- '$.xgafv'?: string;
3612
+ '$.xgafv'?: '1' | '2';
3497
3613
  /** OAuth access token. */
3498
3614
  access_token?: string;
3499
3615
  /** Data format for response. */
3500
- alt?: string;
3616
+ alt?: 'json' | 'media' | 'proto';
3501
3617
  /** JSONP */
3502
3618
  callback?: string;
3503
3619
  /** Selector specifying which fields to include in a partial response. */
@@ -3529,11 +3645,11 @@ declare namespace gapi.client {
3529
3645
  /** Deletes a backup. */
3530
3646
  delete(request?: {
3531
3647
  /** V1 error format. */
3532
- '$.xgafv'?: string;
3648
+ '$.xgafv'?: '1' | '2';
3533
3649
  /** OAuth access token. */
3534
3650
  access_token?: string;
3535
3651
  /** Data format for response. */
3536
- alt?: string;
3652
+ alt?: 'json' | 'media' | 'proto';
3537
3653
  /** JSONP */
3538
3654
  callback?: string;
3539
3655
  /** Selector specifying which fields to include in a partial response. */
@@ -3556,11 +3672,11 @@ declare namespace gapi.client {
3556
3672
  /** Gets information about a backup. */
3557
3673
  get(request?: {
3558
3674
  /** V1 error format. */
3559
- '$.xgafv'?: string;
3675
+ '$.xgafv'?: '1' | '2';
3560
3676
  /** OAuth access token. */
3561
3677
  access_token?: string;
3562
3678
  /** Data format for response. */
3563
- alt?: string;
3679
+ alt?: 'json' | 'media' | 'proto';
3564
3680
  /** JSONP */
3565
3681
  callback?: string;
3566
3682
  /** Selector specifying which fields to include in a partial response. */
@@ -3583,11 +3699,11 @@ declare namespace gapi.client {
3583
3699
  /** Lists all the backups. */
3584
3700
  list(request?: {
3585
3701
  /** V1 error format. */
3586
- '$.xgafv'?: string;
3702
+ '$.xgafv'?: '1' | '2';
3587
3703
  /** OAuth access token. */
3588
3704
  access_token?: string;
3589
3705
  /** Data format for response. */
3590
- alt?: string;
3706
+ alt?: 'json' | 'media' | 'proto';
3591
3707
  /** JSONP */
3592
3708
  callback?: string;
3593
3709
  /** Selector specifying which fields to include in a partial response. */
@@ -3614,11 +3730,11 @@ declare namespace gapi.client {
3614
3730
  /** Gets information about a location. */
3615
3731
  get(request?: {
3616
3732
  /** V1 error format. */
3617
- '$.xgafv'?: string;
3733
+ '$.xgafv'?: '1' | '2';
3618
3734
  /** OAuth access token. */
3619
3735
  access_token?: string;
3620
3736
  /** Data format for response. */
3621
- alt?: string;
3737
+ alt?: 'json' | 'media' | 'proto';
3622
3738
  /** JSONP */
3623
3739
  callback?: string;
3624
3740
  /** Selector specifying which fields to include in a partial response. */
@@ -3641,11 +3757,11 @@ declare namespace gapi.client {
3641
3757
  /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
3642
3758
  list(request?: {
3643
3759
  /** V1 error format. */
3644
- '$.xgafv'?: string;
3760
+ '$.xgafv'?: '1' | '2';
3645
3761
  /** OAuth access token. */
3646
3762
  access_token?: string;
3647
3763
  /** Data format for response. */
3648
- alt?: string;
3764
+ alt?: 'json' | 'media' | 'proto';
3649
3765
  /** JSONP */
3650
3766
  callback?: string;
3651
3767
  /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */