|
151 | 151 | ], |
152 | 152 | "parameters": { |
153 | 153 | "databaseId": { |
154 | | - "description": "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.", |
| 154 | + "description": "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.", |
155 | 155 | "location": "query", |
156 | 156 | "type": "string" |
157 | 157 | }, |
|
1706 | 1706 | } |
1707 | 1707 | } |
1708 | 1708 | }, |
1709 | | - "revision": "20240804", |
| 1709 | + "revision": "20240822", |
1710 | 1710 | "rootUrl": "https://firestore.googleapis.com/", |
1711 | 1711 | "schemas": { |
1712 | 1712 | "Aggregation": { |
|
2407 | 2407 | ], |
2408 | 2408 | "type": "string" |
2409 | 2409 | }, |
| 2410 | + "distanceResultField": { |
| 2411 | + "description": "Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations.", |
| 2412 | + "type": "string" |
| 2413 | + }, |
| 2414 | + "distanceThreshold": { |
| 2415 | + "description": "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", |
| 2416 | + "format": "double", |
| 2417 | + "type": "number" |
| 2418 | + }, |
2410 | 2419 | "limit": { |
2411 | 2420 | "description": "Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.", |
2412 | 2421 | "format": "int32", |
|
2521 | 2530 | "id": "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata", |
2522 | 2531 | "properties": { |
2523 | 2532 | "collectionIds": { |
2524 | | - "description": "The ids of the collection groups that are being deleted.", |
| 2533 | + "description": "The IDs of the collection groups that are being deleted.", |
2525 | 2534 | "items": { |
2526 | 2535 | "type": "string" |
2527 | 2536 | }, |
|
2533 | 2542 | "type": "string" |
2534 | 2543 | }, |
2535 | 2544 | "namespaceIds": { |
2536 | | - "description": "Which namespace ids are being deleted.", |
| 2545 | + "description": "Which namespace IDs are being deleted.", |
2537 | 2546 | "items": { |
2538 | 2547 | "type": "string" |
2539 | 2548 | }, |
|
2722 | 2731 | "type": "string" |
2723 | 2732 | }, |
2724 | 2733 | "keyPrefix": { |
2725 | | - "description": "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).", |
| 2734 | + "description": "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).", |
2726 | 2735 | "readOnly": true, |
2727 | 2736 | "type": "string" |
2728 | 2737 | }, |
|
2794 | 2803 | "type": "object" |
2795 | 2804 | }, |
2796 | 2805 | "GoogleFirestoreAdminV1EncryptionConfig": { |
2797 | | - "description": "Encryption configuration for a new database being created from another source. The source could be a Backup or a DatabaseSnapshot.", |
| 2806 | + "description": "Encryption configuration for a new database being created from another source. The source could be a Backup .", |
2798 | 2807 | "id": "GoogleFirestoreAdminV1EncryptionConfig", |
2799 | 2808 | "properties": { |
2800 | 2809 | "customerManagedEncryption": { |
|
2817 | 2826 | "id": "GoogleFirestoreAdminV1ExportDocumentsMetadata", |
2818 | 2827 | "properties": { |
2819 | 2828 | "collectionIds": { |
2820 | | - "description": "Which collection ids are being exported.", |
| 2829 | + "description": "Which collection IDs are being exported.", |
2821 | 2830 | "items": { |
2822 | 2831 | "type": "string" |
2823 | 2832 | }, |
|
2829 | 2838 | "type": "string" |
2830 | 2839 | }, |
2831 | 2840 | "namespaceIds": { |
2832 | | - "description": "Which namespace ids are being exported.", |
| 2841 | + "description": "Which namespace IDs are being exported.", |
2833 | 2842 | "items": { |
2834 | 2843 | "type": "string" |
2835 | 2844 | }, |
|
2889 | 2898 | "id": "GoogleFirestoreAdminV1ExportDocumentsRequest", |
2890 | 2899 | "properties": { |
2891 | 2900 | "collectionIds": { |
2892 | | - "description": "Which collection ids to export. Unspecified means all collections. Each collection id in this list must be unique.", |
| 2901 | + "description": "Which collection IDs to export. Unspecified means all collections. Each collection ID in this list must be unique.", |
2893 | 2902 | "items": { |
2894 | 2903 | "type": "string" |
2895 | 2904 | }, |
|
2926 | 2935 | "type": "object" |
2927 | 2936 | }, |
2928 | 2937 | "GoogleFirestoreAdminV1Field": { |
2929 | | - "description": "Represents a single field in the database. Fields are grouped by their \"Collection Group\", which represent all collections in the database with the same id.", |
| 2938 | + "description": "Represents a single field in the database. Fields are grouped by their \"Collection Group\", which represent all collections in the database with the same ID.", |
2930 | 2939 | "id": "GoogleFirestoreAdminV1Field", |
2931 | 2940 | "properties": { |
2932 | 2941 | "indexConfig": { |
|
3025 | 3034 | "id": "GoogleFirestoreAdminV1ImportDocumentsMetadata", |
3026 | 3035 | "properties": { |
3027 | 3036 | "collectionIds": { |
3028 | | - "description": "Which collection ids are being imported.", |
| 3037 | + "description": "Which collection IDs are being imported.", |
3029 | 3038 | "items": { |
3030 | 3039 | "type": "string" |
3031 | 3040 | }, |
|
3041 | 3050 | "type": "string" |
3042 | 3051 | }, |
3043 | 3052 | "namespaceIds": { |
3044 | | - "description": "Which namespace ids are being imported.", |
| 3053 | + "description": "Which namespace IDs are being imported.", |
3045 | 3054 | "items": { |
3046 | 3055 | "type": "string" |
3047 | 3056 | }, |
|
3092 | 3101 | "id": "GoogleFirestoreAdminV1ImportDocumentsRequest", |
3093 | 3102 | "properties": { |
3094 | 3103 | "collectionIds": { |
3095 | | - "description": "Which collection ids to import. Unspecified means all collections included in the import. Each collection id in this list must be unique.", |
| 3104 | + "description": "Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.", |
3096 | 3105 | "items": { |
3097 | 3106 | "type": "string" |
3098 | 3107 | }, |
|
3140 | 3149 | "type": "string" |
3141 | 3150 | }, |
3142 | 3151 | "queryScope": { |
3143 | | - "description": "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.", |
| 3152 | + "description": "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.", |
3144 | 3153 | "enum": [ |
3145 | 3154 | "QUERY_SCOPE_UNSPECIFIED", |
3146 | 3155 | "COLLECTION", |
|
3149 | 3158 | ], |
3150 | 3159 | "enumDescriptions": [ |
3151 | 3160 | "The query scope is unspecified. Not a valid option.", |
3152 | | - "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 collection id specified by the index.", |
3153 | | - "Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.", |
| 3161 | + "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 collection ID specified by the index.", |
| 3162 | + "Indexes with a collection group query scope specified allow queries against all collections that has the collection ID specified by the index.", |
3154 | 3163 | "Include all the collections's ancestor in the index. Only available for Datastore Mode databases." |
3155 | 3164 | ], |
3156 | 3165 | "type": "string" |
|
3492 | 3501 | "id": "GoogleFirestoreAdminV1RestoreDatabaseRequest", |
3493 | 3502 | "properties": { |
3494 | 3503 | "backup": { |
3495 | | - "description": "Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", |
| 3504 | + "description": "Required. Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", |
3496 | 3505 | "type": "string" |
3497 | 3506 | }, |
3498 | 3507 | "databaseId": { |
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.", |
| 3508 | + "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.", |
3500 | 3509 | "type": "string" |
3501 | 3510 | }, |
3502 | 3511 | "encryptionConfig": { |
|
0 commit comments