Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Commit 23ce891

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: Expose the FindNearest.distance_result_field parameter (#2067)
- [ ] Regenerate this pull request now. feat: Expose the `FindNearest.distance_threshold` parameter PiperOrigin-RevId: 660557033 Source-Link: https://togithub.com/googleapis/googleapis/commit/28685f723d37bea3115876d423e7dbf70819e3ed Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/38f25b0bcf54613758ed55a6390bc84e40368dc2 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzhmMjViMGJjZjU0NjEzNzU4ZWQ1NWE2MzkwYmM4NGU0MDM2OGRjMiJ9 chore: expose new experimental FindNearest distance params to the preview branch docs: minor documentation clarifications on FindNearest DistanceMeasure options PiperOrigin-RevId: 655267922 Source-Link: https://togithub.com/googleapis/googleapis/commit/7858db457900d9dd8924ce88ce1a7dd3c66cfbe6 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/c0754282e8062565959b52391bb3addb870267b8 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYzA3NTQyODJlODA2MjU2NTk1OWI1MjM5MWJiM2FkZGI4NzAyNjdiOCJ9 feat: add bulk delete api docs: update field api description PiperOrigin-RevId: 642337904 Source-Link: https://togithub.com/googleapis/googleapis/commit/9aab32eafe489f073486839678b538f93ca0c0a7 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/757cf9d8e2d139d7b2871ce013d5e2edc40176d3 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzU3Y2Y5ZDhlMmQxMzlkN2IyODcxY2UwMTNkNWUyZWRjNDAxNzZkMyJ9 BEGIN_COMMIT_OVERRIDE feat: Expose the proto changes to support FindNearest.distance_result_field parameter and the FindNearest.distance_threshold parameter feat: Expose proto changes for the bulk delete api END_COMMIT_OVERRIDE
1 parent e326e41 commit 23ce891

23 files changed

Lines changed: 37944 additions & 36189 deletions

‎dev/protos/admin_v1.json‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,34 @@
633633
}
634634
]
635635
},
636+
"BulkDeleteDocuments": {
637+
"requestType": "BulkDeleteDocumentsRequest",
638+
"responseType": "google.longrunning.Operation",
639+
"options": {
640+
"(google.api.http).post": "/v1/{name=projects/*/databases/*}:bulkDeleteDocuments",
641+
"(google.api.http).body": "*",
642+
"(google.api.method_signature)": "name",
643+
"(google.longrunning.operation_info).response_type": "BulkDeleteDocumentsResponse",
644+
"(google.longrunning.operation_info).metadata_type": "BulkDeleteDocumentsMetadata"
645+
},
646+
"parsedOptions": [
647+
{
648+
"(google.api.http)": {
649+
"post": "/v1/{name=projects/*/databases/*}:bulkDeleteDocuments",
650+
"body": "*"
651+
}
652+
},
653+
{
654+
"(google.api.method_signature)": "name"
655+
},
656+
{
657+
"(google.longrunning.operation_info)": {
658+
"response_type": "BulkDeleteDocumentsResponse",
659+
"metadata_type": "BulkDeleteDocumentsMetadata"
660+
}
661+
}
662+
]
663+
},
636664
"CreateDatabase": {
637665
"requestType": "CreateDatabaseRequest",
638666
"responseType": "google.longrunning.Operation",
@@ -934,6 +962,10 @@
934962
"(google.api.field_behavior)": "REQUIRED",
935963
"(google.api.resource_reference).child_type": "firestore.googleapis.com/Database"
936964
}
965+
},
966+
"showDeleted": {
967+
"type": "bool",
968+
"id": 4
937969
}
938970
}
939971
},
@@ -1308,6 +1340,37 @@
13081340
}
13091341
}
13101342
},
1343+
"BulkDeleteDocumentsRequest": {
1344+
"fields": {
1345+
"name": {
1346+
"type": "string",
1347+
"id": 1,
1348+
"options": {
1349+
"(google.api.field_behavior)": "REQUIRED",
1350+
"(google.api.resource_reference).type": "firestore.googleapis.com/Database"
1351+
}
1352+
},
1353+
"collectionIds": {
1354+
"rule": "repeated",
1355+
"type": "string",
1356+
"id": 2,
1357+
"options": {
1358+
"(google.api.field_behavior)": "OPTIONAL"
1359+
}
1360+
},
1361+
"namespaceIds": {
1362+
"rule": "repeated",
1363+
"type": "string",
1364+
"id": 3,
1365+
"options": {
1366+
"(google.api.field_behavior)": "OPTIONAL"
1367+
}
1368+
}
1369+
}
1370+
},
1371+
"BulkDeleteDocumentsResponse": {
1372+
"fields": {}
1373+
},
13111374
"GetBackupRequest": {
13121375
"fields": {
13131376
"name": {
@@ -1570,6 +1633,44 @@
15701633
}
15711634
}
15721635
},
1636+
"BulkDeleteDocumentsMetadata": {
1637+
"fields": {
1638+
"startTime": {
1639+
"type": "google.protobuf.Timestamp",
1640+
"id": 1
1641+
},
1642+
"endTime": {
1643+
"type": "google.protobuf.Timestamp",
1644+
"id": 2
1645+
},
1646+
"operationState": {
1647+
"type": "OperationState",
1648+
"id": 3
1649+
},
1650+
"progressDocuments": {
1651+
"type": "Progress",
1652+
"id": 4
1653+
},
1654+
"progressBytes": {
1655+
"type": "Progress",
1656+
"id": 5
1657+
},
1658+
"collectionIds": {
1659+
"rule": "repeated",
1660+
"type": "string",
1661+
"id": 6
1662+
},
1663+
"namespaceIds": {
1664+
"rule": "repeated",
1665+
"type": "string",
1666+
"id": 7
1667+
},
1668+
"snapshotTime": {
1669+
"type": "google.protobuf.Timestamp",
1670+
"id": 8
1671+
}
1672+
}
1673+
},
15731674
"ExportDocumentsResponse": {
15741675
"fields": {
15751676
"outputUriPrefix": {

‎dev/protos/firestore_admin_v1_proto_api.d.ts‎

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -918,6 +918,20 @@ export namespace google {
918918
*/
919919
public importDocuments(request: google.firestore.admin.v1.IImportDocumentsRequest): Promise<google.longrunning.Operation>;
920920

921+
/**
922+
* Calls BulkDeleteDocuments.
923+
* @param request BulkDeleteDocumentsRequest message or plain object
924+
* @param callback Node-style callback called with the error, if any, and Operation
925+
*/
926+
public bulkDeleteDocuments(request: google.firestore.admin.v1.IBulkDeleteDocumentsRequest, callback: google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocumentsCallback): void;
927+
928+
/**
929+
* Calls BulkDeleteDocuments.
930+
* @param request BulkDeleteDocumentsRequest message or plain object
931+
* @returns Promise
932+
*/
933+
public bulkDeleteDocuments(request: google.firestore.admin.v1.IBulkDeleteDocumentsRequest): Promise<google.longrunning.Operation>;
934+
921935
/**
922936
* Calls CreateDatabase.
923937
* @param request CreateDatabaseRequest message or plain object
@@ -1180,6 +1194,13 @@ export namespace google {
11801194
*/
11811195
type ImportDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
11821196

1197+
/**
1198+
* Callback as used by {@link google.firestore.admin.v1.FirestoreAdmin#bulkDeleteDocuments}.
1199+
* @param error Error, if any
1200+
* @param [response] Operation
1201+
*/
1202+
type BulkDeleteDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
1203+
11831204
/**
11841205
* Callback as used by {@link google.firestore.admin.v1.FirestoreAdmin#createDatabase}.
11851206
* @param error Error, if any
@@ -1284,6 +1305,9 @@ export namespace google {
12841305

12851306
/** ListDatabasesRequest parent */
12861307
parent?: (string|null);
1308+
1309+
/** ListDatabasesRequest showDeleted */
1310+
showDeleted?: (boolean|null);
12871311
}
12881312

12891313
/** Represents a ListDatabasesRequest. */
@@ -1298,6 +1322,9 @@ export namespace google {
12981322
/** ListDatabasesRequest parent. */
12991323
public parent: string;
13001324

1325+
/** ListDatabasesRequest showDeleted. */
1326+
public showDeleted: boolean;
1327+
13011328
/**
13021329
* Creates a ListDatabasesRequest message from a plain object. Also converts values to their respective internal types.
13031330
* @param object Plain object
@@ -2653,6 +2680,108 @@ export namespace google {
26532680
public static getTypeUrl(typeUrlPrefix?: string): string;
26542681
}
26552682

2683+
/** Properties of a BulkDeleteDocumentsRequest. */
2684+
interface IBulkDeleteDocumentsRequest {
2685+
2686+
/** BulkDeleteDocumentsRequest name */
2687+
name?: (string|null);
2688+
2689+
/** BulkDeleteDocumentsRequest collectionIds */
2690+
collectionIds?: (string[]|null);
2691+
2692+
/** BulkDeleteDocumentsRequest namespaceIds */
2693+
namespaceIds?: (string[]|null);
2694+
}
2695+
2696+
/** Represents a BulkDeleteDocumentsRequest. */
2697+
class BulkDeleteDocumentsRequest implements IBulkDeleteDocumentsRequest {
2698+
2699+
/**
2700+
* Constructs a new BulkDeleteDocumentsRequest.
2701+
* @param [properties] Properties to set
2702+
*/
2703+
constructor(properties?: google.firestore.admin.v1.IBulkDeleteDocumentsRequest);
2704+
2705+
/** BulkDeleteDocumentsRequest name. */
2706+
public name: string;
2707+
2708+
/** BulkDeleteDocumentsRequest collectionIds. */
2709+
public collectionIds: string[];
2710+
2711+
/** BulkDeleteDocumentsRequest namespaceIds. */
2712+
public namespaceIds: string[];
2713+
2714+
/**
2715+
* Creates a BulkDeleteDocumentsRequest message from a plain object. Also converts values to their respective internal types.
2716+
* @param object Plain object
2717+
* @returns BulkDeleteDocumentsRequest
2718+
*/
2719+
public static fromObject(object: { [k: string]: any }): google.firestore.admin.v1.BulkDeleteDocumentsRequest;
2720+
2721+
/**
2722+
* Creates a plain object from a BulkDeleteDocumentsRequest message. Also converts values to other types if specified.
2723+
* @param message BulkDeleteDocumentsRequest
2724+
* @param [options] Conversion options
2725+
* @returns Plain object
2726+
*/
2727+
public static toObject(message: google.firestore.admin.v1.BulkDeleteDocumentsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
2728+
2729+
/**
2730+
* Converts this BulkDeleteDocumentsRequest to JSON.
2731+
* @returns JSON object
2732+
*/
2733+
public toJSON(): { [k: string]: any };
2734+
2735+
/**
2736+
* Gets the default type url for BulkDeleteDocumentsRequest
2737+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
2738+
* @returns The default type url
2739+
*/
2740+
public static getTypeUrl(typeUrlPrefix?: string): string;
2741+
}
2742+
2743+
/** Properties of a BulkDeleteDocumentsResponse. */
2744+
interface IBulkDeleteDocumentsResponse {
2745+
}
2746+
2747+
/** Represents a BulkDeleteDocumentsResponse. */
2748+
class BulkDeleteDocumentsResponse implements IBulkDeleteDocumentsResponse {
2749+
2750+
/**
2751+
* Constructs a new BulkDeleteDocumentsResponse.
2752+
* @param [properties] Properties to set
2753+
*/
2754+
constructor(properties?: google.firestore.admin.v1.IBulkDeleteDocumentsResponse);
2755+
2756+
/**
2757+
* Creates a BulkDeleteDocumentsResponse message from a plain object. Also converts values to their respective internal types.
2758+
* @param object Plain object
2759+
* @returns BulkDeleteDocumentsResponse
2760+
*/
2761+
public static fromObject(object: { [k: string]: any }): google.firestore.admin.v1.BulkDeleteDocumentsResponse;
2762+
2763+
/**
2764+
* Creates a plain object from a BulkDeleteDocumentsResponse message. Also converts values to other types if specified.
2765+
* @param message BulkDeleteDocumentsResponse
2766+
* @param [options] Conversion options
2767+
* @returns Plain object
2768+
*/
2769+
public static toObject(message: google.firestore.admin.v1.BulkDeleteDocumentsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
2770+
2771+
/**
2772+
* Converts this BulkDeleteDocumentsResponse to JSON.
2773+
* @returns JSON object
2774+
*/
2775+
public toJSON(): { [k: string]: any };
2776+
2777+
/**
2778+
* Gets the default type url for BulkDeleteDocumentsResponse
2779+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
2780+
* @returns The default type url
2781+
*/
2782+
public static getTypeUrl(typeUrlPrefix?: string): string;
2783+
}
2784+
26562785
/** Properties of a GetBackupRequest. */
26572786
interface IGetBackupRequest {
26582787

@@ -3384,6 +3513,96 @@ export namespace google {
33843513
public static getTypeUrl(typeUrlPrefix?: string): string;
33853514
}
33863515

3516+
/** Properties of a BulkDeleteDocumentsMetadata. */
3517+
interface IBulkDeleteDocumentsMetadata {
3518+
3519+
/** BulkDeleteDocumentsMetadata startTime */
3520+
startTime?: (google.protobuf.ITimestamp|null);
3521+
3522+
/** BulkDeleteDocumentsMetadata endTime */
3523+
endTime?: (google.protobuf.ITimestamp|null);
3524+
3525+
/** BulkDeleteDocumentsMetadata operationState */
3526+
operationState?: (google.firestore.admin.v1.OperationState|null);
3527+
3528+
/** BulkDeleteDocumentsMetadata progressDocuments */
3529+
progressDocuments?: (google.firestore.admin.v1.IProgress|null);
3530+
3531+
/** BulkDeleteDocumentsMetadata progressBytes */
3532+
progressBytes?: (google.firestore.admin.v1.IProgress|null);
3533+
3534+
/** BulkDeleteDocumentsMetadata collectionIds */
3535+
collectionIds?: (string[]|null);
3536+
3537+
/** BulkDeleteDocumentsMetadata namespaceIds */
3538+
namespaceIds?: (string[]|null);
3539+
3540+
/** BulkDeleteDocumentsMetadata snapshotTime */
3541+
snapshotTime?: (google.protobuf.ITimestamp|null);
3542+
}
3543+
3544+
/** Represents a BulkDeleteDocumentsMetadata. */
3545+
class BulkDeleteDocumentsMetadata implements IBulkDeleteDocumentsMetadata {
3546+
3547+
/**
3548+
* Constructs a new BulkDeleteDocumentsMetadata.
3549+
* @param [properties] Properties to set
3550+
*/
3551+
constructor(properties?: google.firestore.admin.v1.IBulkDeleteDocumentsMetadata);
3552+
3553+
/** BulkDeleteDocumentsMetadata startTime. */
3554+
public startTime?: (google.protobuf.ITimestamp|null);
3555+
3556+
/** BulkDeleteDocumentsMetadata endTime. */
3557+
public endTime?: (google.protobuf.ITimestamp|null);
3558+
3559+
/** BulkDeleteDocumentsMetadata operationState. */
3560+
public operationState: google.firestore.admin.v1.OperationState;
3561+
3562+
/** BulkDeleteDocumentsMetadata progressDocuments. */
3563+
public progressDocuments?: (google.firestore.admin.v1.IProgress|null);
3564+
3565+
/** BulkDeleteDocumentsMetadata progressBytes. */
3566+
public progressBytes?: (google.firestore.admin.v1.IProgress|null);
3567+
3568+
/** BulkDeleteDocumentsMetadata collectionIds. */
3569+
public collectionIds: string[];
3570+
3571+
/** BulkDeleteDocumentsMetadata namespaceIds. */
3572+
public namespaceIds: string[];
3573+
3574+
/** BulkDeleteDocumentsMetadata snapshotTime. */
3575+
public snapshotTime?: (google.protobuf.ITimestamp|null);
3576+
3577+
/**
3578+
* Creates a BulkDeleteDocumentsMetadata message from a plain object. Also converts values to their respective internal types.
3579+
* @param object Plain object
3580+
* @returns BulkDeleteDocumentsMetadata
3581+
*/
3582+
public static fromObject(object: { [k: string]: any }): google.firestore.admin.v1.BulkDeleteDocumentsMetadata;
3583+
3584+
/**
3585+
* Creates a plain object from a BulkDeleteDocumentsMetadata message. Also converts values to other types if specified.
3586+
* @param message BulkDeleteDocumentsMetadata
3587+
* @param [options] Conversion options
3588+
* @returns Plain object
3589+
*/
3590+
public static toObject(message: google.firestore.admin.v1.BulkDeleteDocumentsMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
3591+
3592+
/**
3593+
* Converts this BulkDeleteDocumentsMetadata to JSON.
3594+
* @returns JSON object
3595+
*/
3596+
public toJSON(): { [k: string]: any };
3597+
3598+
/**
3599+
* Gets the default type url for BulkDeleteDocumentsMetadata
3600+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
3601+
* @returns The default type url
3602+
*/
3603+
public static getTypeUrl(typeUrlPrefix?: string): string;
3604+
}
3605+
33873606
/** Properties of an ExportDocumentsResponse. */
33883607
interface IExportDocumentsResponse {
33893608

0 commit comments

Comments
 (0)