@maxim_mazurok/gapi.client.firestore-v1 0.0.20240521 → 0.0.20240610
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 +10 -4
- 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: 20240610
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -378,7 +378,7 @@ declare namespace gapi.client {
|
|
|
378
378
|
interface GoogleFirestoreAdminV1Field {
|
|
379
379
|
/** The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes. */
|
|
380
380
|
indexConfig?: GoogleFirestoreAdminV1IndexConfig;
|
|
381
|
-
/** Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path
|
|
381
|
+
/** Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */
|
|
382
382
|
name?: string;
|
|
383
383
|
/** The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`. */
|
|
384
384
|
ttlConfig?: GoogleFirestoreAdminV1TtlConfig;
|
|
@@ -536,6 +536,12 @@ declare namespace gapi.client {
|
|
|
536
536
|
databaseId?: string;
|
|
537
537
|
/** Database snapshot to restore from. The source database must exist and have enabled PITR. The restored database will be created in the same location as the source database. */
|
|
538
538
|
databaseSnapshot?: GoogleFirestoreAdminV1DatabaseSnapshot;
|
|
539
|
+
/** Use Customer Managed Encryption Keys (CMEK) for encryption. 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}`. */
|
|
540
|
+
kmsKeyName?: string;
|
|
541
|
+
/** The restored database will use the same encryption configuration as the backup. This is the default option when no `encryption_config` is specified. */
|
|
542
|
+
useBackupEncryption?: any;
|
|
543
|
+
/** Use Google default encryption. */
|
|
544
|
+
useGoogleDefaultEncryption?: any;
|
|
539
545
|
}
|
|
540
546
|
interface GoogleFirestoreAdminV1Stats {
|
|
541
547
|
/** Output only. The total number of documents contained in the backup. */
|
|
@@ -1187,7 +1193,7 @@ declare namespace gapi.client {
|
|
|
1187
1193
|
fields?: string;
|
|
1188
1194
|
/** 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. */
|
|
1189
1195
|
key?: string;
|
|
1190
|
-
/** Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path
|
|
1196
|
+
/** Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */
|
|
1191
1197
|
name: string;
|
|
1192
1198
|
/** OAuth 2.0 token for the current user. */
|
|
1193
1199
|
oauth_token?: string;
|
|
@@ -1218,7 +1224,7 @@ declare namespace gapi.client {
|
|
|
1218
1224
|
fields?: string;
|
|
1219
1225
|
/** 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. */
|
|
1220
1226
|
key?: string;
|
|
1221
|
-
/** Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path
|
|
1227
|
+
/** Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. */
|
|
1222
1228
|
name: string;
|
|
1223
1229
|
/** OAuth 2.0 token for the current user. */
|
|
1224
1230
|
oauth_token?: string;
|