|
1421 | 1421 | "operations": {
|
1422 | 1422 | "methods": {
|
1423 | 1423 | "cancel": {
|
1424 |
| - "description": "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`.", |
| 1424 | + "description": "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`.", |
1425 | 1425 | "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}:cancel",
|
1426 | 1426 | "httpMethod": "POST",
|
1427 | 1427 | "id": "firestore.projects.databases.operations.cancel",
|
|
1711 | 1711 | }
|
1712 | 1712 | }
|
1713 | 1713 | },
|
1714 |
| - "revision": "20240904", |
| 1714 | + "revision": "20250120", |
1715 | 1715 | "rootUrl": "https://firestore.googleapis.com/",
|
1716 | 1716 | "schemas": {
|
1717 | 1717 | "Aggregation": {
|
|
2417 | 2417 | "type": "string"
|
2418 | 2418 | },
|
2419 | 2419 | "distanceThreshold": {
|
2420 |
| - "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", |
| 2420 | + "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", |
2421 | 2421 | "format": "double",
|
2422 | 2422 | "type": "number"
|
2423 | 2423 | },
|
|
3150 | 3150 | "description": "The API scope supported by this index.",
|
3151 | 3151 | "enum": [
|
3152 | 3152 | "ANY_API",
|
3153 |
| - "DATASTORE_MODE_API" |
| 3153 | + "DATASTORE_MODE_API", |
| 3154 | + "IGNITE_API" |
3154 | 3155 | ],
|
3155 | 3156 | "enumDescriptions": [
|
3156 | 3157 | "The index can only be used by the Firestore Native query API. This is the default.",
|
3157 |
| - "The index can only be used by the Firestore in Datastore Mode query API." |
| 3158 | + "The index can only be used by the Firestore in Datastore Mode query API.", |
| 3159 | + "The index can only be used by Ignite." |
| 3160 | + ], |
| 3161 | + "type": "string" |
| 3162 | + }, |
| 3163 | + "density": { |
| 3164 | + "description": "Immutable. The density configuration of the index.", |
| 3165 | + "enum": [ |
| 3166 | + "DENSITY_UNSPECIFIED", |
| 3167 | + "SPARSE_ALL", |
| 3168 | + "SPARSE_ANY", |
| 3169 | + "DENSE" |
| 3170 | + ], |
| 3171 | + "enumDescriptions": [ |
| 3172 | + "Unspecified. It will use database default setting. This value is input only.", |
| 3173 | + "In order for an index entry to be added, the document must contain all fields specified in the index. This is the only allowed value for indexes having ApiScope `ANY_API` and `DATASTORE_MODE_API`.", |
| 3174 | + "In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.", |
| 3175 | + "An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries." |
3158 | 3176 | ],
|
3159 | 3177 | "type": "string"
|
3160 | 3178 | },
|
|
3165 | 3183 | },
|
3166 | 3184 | "type": "array"
|
3167 | 3185 | },
|
| 3186 | + "multikey": { |
| 3187 | + "description": "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 IGNITE_API ApiScope.", |
| 3188 | + "type": "boolean" |
| 3189 | + }, |
3168 | 3190 | "name": {
|
3169 | 3191 | "description": "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.",
|
3170 | 3192 | "type": "string"
|
|
4264 | 4286 | "type": "object"
|
4265 | 4287 | },
|
4266 | 4288 | "StructuredQuery": {
|
4267 |
| - "description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit", |
| 4289 | + "description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest", |
4268 | 4290 | "id": "StructuredQuery",
|
4269 | 4291 | "properties": {
|
4270 | 4292 | "endAt": {
|
|
0 commit comments