Skip to content

Commit

Permalink
feat: Expose the FindNearest.distance_result_field parameter (#2067)
Browse files Browse the repository at this point in the history 
- [ ] 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
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] committed Aug 12, 2024
1 parent e326e41 commit 23ce891
Show file tree
Hide file tree
Showing 23 changed files with 37,944 additions and 36,189 deletions.
101 changes: 101 additions & 0 deletions dev/protos/admin_v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -633,6 +633,34 @@
}
]
},
"BulkDeleteDocuments": {
"requestType": "BulkDeleteDocumentsRequest",
"responseType": "google.longrunning.Operation",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/databases/*}:bulkDeleteDocuments",
"(google.api.http).body": "*",
"(google.api.method_signature)": "name",
"(google.longrunning.operation_info).response_type": "BulkDeleteDocumentsResponse",
"(google.longrunning.operation_info).metadata_type": "BulkDeleteDocumentsMetadata"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/databases/*}:bulkDeleteDocuments",
"body": "*"
}
},
{
"(google.api.method_signature)": "name"
},
{
"(google.longrunning.operation_info)": {
"response_type": "BulkDeleteDocumentsResponse",
"metadata_type": "BulkDeleteDocumentsMetadata"
}
}
]
},
"CreateDatabase": {
"requestType": "CreateDatabaseRequest",
"responseType": "google.longrunning.Operation",
Expand Down Expand Up @@ -934,6 +962,10 @@
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "firestore.googleapis.com/Database"
}
},
"showDeleted": {
"type": "bool",
"id": 4
}
}
},
Expand Down Expand Up @@ -1308,6 +1340,37 @@
}
}
},
"BulkDeleteDocumentsRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "firestore.googleapis.com/Database"
}
},
"collectionIds": {
"rule": "repeated",
"type": "string",
"id": 2,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
},
"namespaceIds": {
"rule": "repeated",
"type": "string",
"id": 3,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
}
},
"BulkDeleteDocumentsResponse": {
"fields": {}
},
"GetBackupRequest": {
"fields": {
"name": {
Expand Down Expand Up @@ -1570,6 +1633,44 @@
}
}
},
"BulkDeleteDocumentsMetadata": {
"fields": {
"startTime": {
"type": "google.protobuf.Timestamp",
"id": 1
},
"endTime": {
"type": "google.protobuf.Timestamp",
"id": 2
},
"operationState": {
"type": "OperationState",
"id": 3
},
"progressDocuments": {
"type": "Progress",
"id": 4
},
"progressBytes": {
"type": "Progress",
"id": 5
},
"collectionIds": {
"rule": "repeated",
"type": "string",
"id": 6
},
"namespaceIds": {
"rule": "repeated",
"type": "string",
"id": 7
},
"snapshotTime": {
"type": "google.protobuf.Timestamp",
"id": 8
}
}
},
"ExportDocumentsResponse": {
"fields": {
"outputUriPrefix": {
Expand Down
219 changes: 219 additions & 0 deletions dev/protos/firestore_admin_v1_proto_api.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -918,6 +918,20 @@ export namespace google {
*/
public importDocuments(request: google.firestore.admin.v1.IImportDocumentsRequest): Promise<google.longrunning.Operation>;

/**
* Calls BulkDeleteDocuments.
* @param request BulkDeleteDocumentsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public bulkDeleteDocuments(request: google.firestore.admin.v1.IBulkDeleteDocumentsRequest, callback: google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocumentsCallback): void;

/**
* Calls BulkDeleteDocuments.
* @param request BulkDeleteDocumentsRequest message or plain object
* @returns Promise
*/
public bulkDeleteDocuments(request: google.firestore.admin.v1.IBulkDeleteDocumentsRequest): Promise<google.longrunning.Operation>;

/**
* Calls CreateDatabase.
* @param request CreateDatabaseRequest message or plain object
Expand Down Expand Up @@ -1180,6 +1194,13 @@ export namespace google {
*/
type ImportDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

/**
* Callback as used by {@link google.firestore.admin.v1.FirestoreAdmin#bulkDeleteDocuments}.
* @param error Error, if any
* @param [response] Operation
*/
type BulkDeleteDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

/**
* Callback as used by {@link google.firestore.admin.v1.FirestoreAdmin#createDatabase}.
* @param error Error, if any
Expand Down Expand Up @@ -1284,6 +1305,9 @@ export namespace google {

/** ListDatabasesRequest parent */
parent?: (string|null);

/** ListDatabasesRequest showDeleted */
showDeleted?: (boolean|null);
}

/** Represents a ListDatabasesRequest. */
Expand All @@ -1298,6 +1322,9 @@ export namespace google {
/** ListDatabasesRequest parent. */
public parent: string;

/** ListDatabasesRequest showDeleted. */
public showDeleted: boolean;

/**
* Creates a ListDatabasesRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
Expand Down Expand Up @@ -2653,6 +2680,108 @@ export namespace google {
public static getTypeUrl(typeUrlPrefix?: string): string;
}

/** Properties of a BulkDeleteDocumentsRequest. */
interface IBulkDeleteDocumentsRequest {

/** BulkDeleteDocumentsRequest name */
name?: (string|null);

/** BulkDeleteDocumentsRequest collectionIds */
collectionIds?: (string[]|null);

/** BulkDeleteDocumentsRequest namespaceIds */
namespaceIds?: (string[]|null);
}

/** Represents a BulkDeleteDocumentsRequest. */
class BulkDeleteDocumentsRequest implements IBulkDeleteDocumentsRequest {

/**
* Constructs a new BulkDeleteDocumentsRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.firestore.admin.v1.IBulkDeleteDocumentsRequest);

/** BulkDeleteDocumentsRequest name. */
public name: string;

/** BulkDeleteDocumentsRequest collectionIds. */
public collectionIds: string[];

/** BulkDeleteDocumentsRequest namespaceIds. */
public namespaceIds: string[];

/**
* Creates a BulkDeleteDocumentsRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns BulkDeleteDocumentsRequest
*/
public static fromObject(object: { [k: string]: any }): google.firestore.admin.v1.BulkDeleteDocumentsRequest;

/**
* Creates a plain object from a BulkDeleteDocumentsRequest message. Also converts values to other types if specified.
* @param message BulkDeleteDocumentsRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.firestore.admin.v1.BulkDeleteDocumentsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

/**
* Converts this BulkDeleteDocumentsRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };

/**
* Gets the default type url for BulkDeleteDocumentsRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}

/** Properties of a BulkDeleteDocumentsResponse. */
interface IBulkDeleteDocumentsResponse {
}

/** Represents a BulkDeleteDocumentsResponse. */
class BulkDeleteDocumentsResponse implements IBulkDeleteDocumentsResponse {

/**
* Constructs a new BulkDeleteDocumentsResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.firestore.admin.v1.IBulkDeleteDocumentsResponse);

/**
* Creates a BulkDeleteDocumentsResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns BulkDeleteDocumentsResponse
*/
public static fromObject(object: { [k: string]: any }): google.firestore.admin.v1.BulkDeleteDocumentsResponse;

/**
* Creates a plain object from a BulkDeleteDocumentsResponse message. Also converts values to other types if specified.
* @param message BulkDeleteDocumentsResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.firestore.admin.v1.BulkDeleteDocumentsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };

/**
* Converts this BulkDeleteDocumentsResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };

/**
* Gets the default type url for BulkDeleteDocumentsResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}

/** Properties of a GetBackupRequest. */
interface IGetBackupRequest {

Expand Down Expand Up @@ -3384,6 +3513,96 @@ export namespace google {
public static getTypeUrl(typeUrlPrefix?: string): string;
}

/** Properties of a BulkDeleteDocumentsMetadata. */
interface IBulkDeleteDocumentsMetadata {

/** BulkDeleteDocumentsMetadata startTime */
startTime?: (google.protobuf.ITimestamp|null);

/** BulkDeleteDocumentsMetadata endTime */
endTime?: (google.protobuf.ITimestamp|null);

/** BulkDeleteDocumentsMetadata operationState */
operationState?: (google.firestore.admin.v1.OperationState|null);

/** BulkDeleteDocumentsMetadata progressDocuments */
progressDocuments?: (google.firestore.admin.v1.IProgress|null);

/** BulkDeleteDocumentsMetadata progressBytes */
progressBytes?: (google.firestore.admin.v1.IProgress|null);

/** BulkDeleteDocumentsMetadata collectionIds */
collectionIds?: (string[]|null);

/** BulkDeleteDocumentsMetadata namespaceIds */
namespaceIds?: (string[]|null);

/** BulkDeleteDocumentsMetadata snapshotTime */
snapshotTime?: (google.protobuf.ITimestamp|null);
}

/** Represents a BulkDeleteDocumentsMetadata. */
class BulkDeleteDocumentsMetadata implements IBulkDeleteDocumentsMetadata {

/**
* Constructs a new BulkDeleteDocumentsMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.firestore.admin.v1.IBulkDeleteDocumentsMetadata);

/** BulkDeleteDocumentsMetadata startTime. */
public startTime?: (google.protobuf.ITimestamp|null);

/** BulkDeleteDocumentsMetadata endTime. */
public endTime?: (google.protobuf.ITimestamp|null);

/** BulkDeleteDocumentsMetadata operationState. */
public operationState: google.firestore.admin.v1.OperationState;

/** BulkDeleteDocumentsMetadata progressDocuments. */
public progressDocuments?: (google.firestore.admin.v1.IProgress|null);

/** BulkDeleteDocumentsMetadata progressBytes. */
public progressBytes?: (google.firestore.admin.v1.IProgress|null);

/** BulkDeleteDocumentsMetadata collectionIds. */
public collectionIds: string[];

/** BulkDeleteDocumentsMetadata namespaceIds. */
public namespaceIds: string[];

/** BulkDeleteDocumentsMetadata snapshotTime. */
public snapshotTime?: (google.protobuf.ITimestamp|null);

/**
* Creates a BulkDeleteDocumentsMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns BulkDeleteDocumentsMetadata
*/
public static fromObject(object: { [k: string]: any }): google.firestore.admin.v1.BulkDeleteDocumentsMetadata;

/**
* Creates a plain object from a BulkDeleteDocumentsMetadata message. Also converts values to other types if specified.
* @param message BulkDeleteDocumentsMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.firestore.admin.v1.BulkDeleteDocumentsMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };

/**
* Converts this BulkDeleteDocumentsMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };

/**
* Gets the default type url for BulkDeleteDocumentsMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}

/** Properties of an ExportDocumentsResponse. */
interface IExportDocumentsResponse {

Expand Down
Loading

0 comments on commit 23ce891

Please sign in to comment.