|
1706 | 1706 | } |
1707 | 1707 | } |
1708 | 1708 | }, |
1709 | | -"revision": "20240713", |
| 1709 | +"revision": "20240804", |
1710 | 1710 | "rootUrl": "https://firestore.googleapis.com/", |
1711 | 1711 | "schemas": { |
1712 | 1712 | "Aggregation": { |
|
2066 | 2066 | "type": "object" |
2067 | 2067 | }, |
2068 | 2068 | "DocumentChange": { |
2069 | | -"description": "A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. For PipelineQueryTargets, `document` will be in the new pipeline format, For a Listen stream with both QueryTargets and PipelineQueryTargets present, if a document matches both types of queries, then a separate DocumentChange messages will be sent out one for each set.", |
| 2069 | +"description": "A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.", |
2070 | 2070 | "id": "DocumentChange", |
2071 | 2071 | "properties": { |
2072 | 2072 | "document": { |
|
2401 | 2401 | ], |
2402 | 2402 | "enumDescriptions": [ |
2403 | 2403 | "Should not be set.", |
2404 | | -"Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more", |
2405 | | -"Compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more.", |
2406 | | -"Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more." |
| 2404 | +"Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more. The resulting distance decreases the more similar two vectors are.", |
| 2405 | +"COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.", |
| 2406 | +"Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The resulting distance increases the more similar two vectors are." |
2407 | 2407 | ], |
2408 | 2408 | "type": "string" |
2409 | 2409 | }, |
|
2630 | 2630 | "properties": {}, |
2631 | 2631 | "type": "object" |
2632 | 2632 | }, |
| 2633 | +"GoogleFirestoreAdminV1CustomerManagedEncryptionOptions": { |
| 2634 | +"description": "The configuration options for using CMEK (Customer Managed Encryption Key) encryption.", |
| 2635 | +"id": "GoogleFirestoreAdminV1CustomerManagedEncryptionOptions", |
| 2636 | +"properties": { |
| 2637 | +"kmsKeyName": { |
| 2638 | +"description": "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}`.", |
| 2639 | +"type": "string" |
| 2640 | +} |
| 2641 | +}, |
| 2642 | +"type": "object" |
| 2643 | +}, |
2633 | 2644 | "GoogleFirestoreAdminV1DailyRecurrence": { |
2634 | 2645 | "description": "Represents a recurring schedule that runs every day. The time zone is UTC.", |
2635 | 2646 | "id": "GoogleFirestoreAdminV1DailyRecurrence", |
|
2782 | 2793 | "properties": {}, |
2783 | 2794 | "type": "object" |
2784 | 2795 | }, |
| 2796 | +"GoogleFirestoreAdminV1EncryptionConfig": { |
| 2797 | +"description": "Encryption configuration for a new database being created from another source. The source could be a Backup or a DatabaseSnapshot.", |
| 2798 | +"id": "GoogleFirestoreAdminV1EncryptionConfig", |
| 2799 | +"properties": { |
| 2800 | +"customerManagedEncryption": { |
| 2801 | +"$ref": "GoogleFirestoreAdminV1CustomerManagedEncryptionOptions", |
| 2802 | +"description": "Use Customer Managed Encryption Keys (CMEK) for encryption." |
| 2803 | +}, |
| 2804 | +"googleDefaultEncryption": { |
| 2805 | +"$ref": "GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions", |
| 2806 | +"description": "Use Google default encryption." |
| 2807 | +}, |
| 2808 | +"useSourceEncryption": { |
| 2809 | +"$ref": "GoogleFirestoreAdminV1SourceEncryptionOptions", |
| 2810 | +"description": "The database will use the same encryption configuration as the source." |
| 2811 | +} |
| 2812 | +}, |
| 2813 | +"type": "object" |
| 2814 | +}, |
2785 | 2815 | "GoogleFirestoreAdminV1ExportDocumentsMetadata": { |
2786 | 2816 | "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.", |
2787 | 2817 | "id": "GoogleFirestoreAdminV1ExportDocumentsMetadata", |
|
2984 | 3014 | "properties": {}, |
2985 | 3015 | "type": "object" |
2986 | 3016 | }, |
| 3017 | +"GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions": { |
| 3018 | +"description": "The configuration options for using Google default encryption.", |
| 3019 | +"id": "GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions", |
| 3020 | +"properties": {}, |
| 3021 | +"type": "object" |
| 3022 | +}, |
2987 | 3023 | "GoogleFirestoreAdminV1ImportDocumentsMetadata": { |
2988 | 3024 | "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.", |
2989 | 3025 | "id": "GoogleFirestoreAdminV1ImportDocumentsMetadata", |
|
3463 | 3499 | "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database id must not be associated with an existing database. 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.", |
3464 | 3500 | "type": "string" |
3465 | 3501 | }, |
3466 | | -"kmsKeyName": { |
3467 | | -"description": "Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as the restored 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}`.", |
3468 | | -"type": "string" |
3469 | | -}, |
3470 | | -"useBackupEncryption": { |
3471 | | -"$ref": "Empty", |
3472 | | -"description": "The restored database will use the same encryption configuration as the backup. This is the default option when no `encryption_config` is specified." |
3473 | | -}, |
3474 | | -"useGoogleDefaultEncryption": { |
3475 | | -"$ref": "Empty", |
3476 | | -"description": "Use Google default encryption." |
| 3502 | +"encryptionConfig": { |
| 3503 | +"$ref": "GoogleFirestoreAdminV1EncryptionConfig", |
| 3504 | +"description": "Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption." |
3477 | 3505 | } |
3478 | 3506 | }, |
3479 | 3507 | "type": "object" |
3480 | 3508 | }, |
| 3509 | +"GoogleFirestoreAdminV1SourceEncryptionOptions": { |
| 3510 | +"description": "The configuration options for using the same encryption method as the source.", |
| 3511 | +"id": "GoogleFirestoreAdminV1SourceEncryptionOptions", |
| 3512 | +"properties": {}, |
| 3513 | +"type": "object" |
| 3514 | +}, |
3481 | 3515 | "GoogleFirestoreAdminV1Stats": { |
3482 | 3516 | "description": "Backup specific statistics.", |
3483 | 3517 | "id": "GoogleFirestoreAdminV1Stats", |
|
0 commit comments