♻️ Add flush proto (#327)

Signed-off-by: vankichi <[email protected]>
vdaas · Dec 24, 2024 · 491e651 · 491e651
1 parent 1199e4d
commit 491e651
Show file tree

Hide file tree

Showing 25 changed files with 373 additions and 2,809 deletions.
diff --git a/Makefile b/Makefile
@@ -44,6 +44,7 @@ TEST_DATASET_PATH = tests/wordvecs1000.json
 PROTOS = \
 	v1/agent/core/agent.proto \
 	v1/vald/filter.proto \
+	v1/vald/flush.proto \
 	v1/vald/insert.proto \
 	v1/vald/object.proto \
 	v1/vald/index.proto  \

diff --git a/src/google/protobuf/descriptor_pb.d.ts b/src/google/protobuf/descriptor_pb.d.ts
@@ -1001,13 +1001,12 @@ export interface MessageOptions {
  */
 export interface FieldOptions {
     /**
-     * NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
      * The ctype option instructs the C++ code generator to use a different
      * representation of the field than it normally would.  See the specific
      * options below.  This option is only implemented to support use of
      * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
-     * type "bytes" in the open source release.
-     * TODO: make ctype actually deprecated.
+     * type "bytes" in the open source release -- sorry, we'll try to include
+     * other types in a future version!
      *
      * @generated from protobuf field: optional google.protobuf.FieldOptions.CType ctype = 1;
      */
@@ -1227,6 +1226,8 @@ export declare enum FieldOptions_JSType {
 }
 /**
  * If set to RETENTION_SOURCE, the option will be omitted from the binary.
+ * Note: as of January 2023, support for this is in progress and does not yet
+ * have an effect (b/264593489).
  *
  * @generated from protobuf enum google.protobuf.FieldOptions.OptionRetention
  */
@@ -1247,7 +1248,8 @@ export declare enum FieldOptions_OptionRetention {
 /**
  * This indicates the types of entities that the field may apply to when used
  * as an option. If it is unset, then the field may be freely used as an
- * option on any kind of entity.
+ * option on any kind of entity. Note: as of January 2023, support for this is
+ * in progress and does not yet have an effect (b/264593489).
  *
  * @generated from protobuf enum google.protobuf.FieldOptions.OptionTargetType
  */
@@ -2018,7 +2020,7 @@ export declare enum Edition {
     EDITION_2024 = 1001,
     /**
      * Placeholder editions for testing feature resolution.  These should not be
-     * used or relied on outside of tests.
+     * used or relyed on outside of tests.
      *
      * @generated from protobuf enum value: EDITION_1_TEST_ONLY = 1;
      */

diff --git a/src/google/protobuf/descriptor_pb.js b/src/google/protobuf/descriptor_pb.js
@@ -286,6 +286,8 @@ var FieldOptions_JSType;
 })(FieldOptions_JSType = exports.FieldOptions_JSType || (exports.FieldOptions_JSType = {}));
 /**
  * If set to RETENTION_SOURCE, the option will be omitted from the binary.
+ * Note: as of January 2023, support for this is in progress and does not yet
+ * have an effect (b/264593489).
  *
  * @generated from protobuf enum google.protobuf.FieldOptions.OptionRetention
  */
@@ -307,7 +309,8 @@ var FieldOptions_OptionRetention;
 /**
  * This indicates the types of entities that the field may apply to when used
  * as an option. If it is unset, then the field may be freely used as an
- * option on any kind of entity.
+ * option on any kind of entity. Note: as of January 2023, support for this is
+ * in progress and does not yet have an effect (b/264593489).
  *
  * @generated from protobuf enum google.protobuf.FieldOptions.OptionTargetType
  */
@@ -566,7 +569,7 @@ var Edition;
     Edition[Edition["EDITION_2024"] = 1001] = "EDITION_2024";
     /**
      * Placeholder editions for testing feature resolution.  These should not be
-     * used or relied on outside of tests.
+     * used or relyed on outside of tests.
      *
      * @generated from protobuf enum value: EDITION_1_TEST_ONLY = 1;
      */

diff --git a/src/vald/v1/vald/filter_pb.grpc-client.d.ts b/src/vald/v1/vald/filter_pb.grpc-client.d.ts
diff --git a/src/vald/v1/vald/filter_pb.grpc-client.js b/src/vald/v1/vald/filter_pb.grpc-client.js
@@ -48,10 +48,7 @@ exports.FilterClient = void 0;
 const filter_pb_1 = require("./filter_pb");
 const grpc = require("@grpc/grpc-js");
 /**
- * Overview
- * Filter Server is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`.
- *
- * Vald Filter Gateway forward user request to user-defined ingress/egress filter components allowing user to run custom logic.
+ * Filter service provides ways to connect to Vald through filter.
  *
  * @generated from protobuf service vald.v1.Filter
  */
@@ -61,16 +58,7 @@ class FilterClient extends grpc.Client {
         this._binaryOptions = binaryOptions;
     }
     /**
-     * Overview
-     * SearchObject RPC is the method to search object(s) similar to request object.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to search object.
      *
      * @generated from protobuf rpc: SearchObject(payload.v1.Search.ObjectRequest) returns (payload.v1.Search.Response);
      */
@@ -79,18 +67,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * StreamSearchObject RPC is the method to search vectors with multi queries(objects) using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).<br>
-     * By using the bidirectional streaming RPC, the search request can be communicated in any order between client and server.
-     * Each Search request and response are independent.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to search multiple objects.
      *
      * @generated from protobuf rpc: MultiSearchObject(payload.v1.Search.MultiObjectRequest) returns (payload.v1.Search.Responses);
      */
@@ -99,21 +76,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * MultiSearchObject RPC is the method to search objects with multiple objects in **1** request.
-     *
-     * <div class="notice">
-     * gRPC has a message size limitation.<br>
-     * Please be careful that the size of the request exceeds the limit.
-     * </div>
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to search object by bidirectional streaming.
      *
      * @generated from protobuf rpc: StreamSearchObject(stream payload.v1.Search.ObjectRequest) returns (stream payload.v1.Search.StreamResponse);
      */
@@ -122,16 +85,7 @@ class FilterClient extends grpc.Client {
         return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options);
     }
     /**
-     * Overview
-     * InsertObject RPC is the method to insert object through Vald Filter Gateway.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method insert object.
      *
      * @generated from protobuf rpc: InsertObject(payload.v1.Insert.ObjectRequest) returns (payload.v1.Object.Location);
      */
@@ -140,20 +94,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * StreamInsertObject RPC is the method to add new multiple object using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
-     *
-     * By using the bidirectional streaming RPC, the insert request can be communicated in any order between client and server.
-     * Each Insert request and response are independent.
-     * It's the recommended method to insert a large number of objects.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * Represent the streaming RPC to insert object by bidirectional streaming.
      *
      * @generated from protobuf rpc: StreamInsertObject(stream payload.v1.Insert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation);
      */
@@ -162,16 +103,7 @@ class FilterClient extends grpc.Client {
         return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options);
     }
     /**
-     * Overview
-     * MultiInsertObject RPC is the method to add multiple new objects in **1** request.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to insert multiple objects.
      *
      * @generated from protobuf rpc: MultiInsertObject(payload.v1.Insert.MultiObjectRequest) returns (payload.v1.Object.Locations);
      */
@@ -180,16 +112,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * UpdateObject RPC is the method to update a single vector.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to update object.
      *
      * @generated from protobuf rpc: UpdateObject(payload.v1.Update.ObjectRequest) returns (payload.v1.Object.Location);
      */
@@ -198,19 +121,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * StreamUpdateObject RPC is the method to update multiple objects using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).<br>
-     * By using the bidirectional streaming RPC, the update request can be communicated in any order between client and server.
-     * Each Update request and response are independent.
-     * It's the recommended method to update the large amount of objects.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to update object by bidirectional streaming.
      *
      * @generated from protobuf rpc: StreamUpdateObject(stream payload.v1.Update.ObjectRequest) returns (stream payload.v1.Object.StreamLocation);
      */
@@ -219,22 +130,7 @@ class FilterClient extends grpc.Client {
         return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options);
     }
     /**
-     * Overview
-     * MultiUpdateObject is the method to update multiple objects in **1** request.
-     *
-     * <div class="notice">
-     * gRPC has the message size limitation.<br>
-     * Please be careful that the size of the request exceed the limit.
-     * </div>
-     * ---
-     * Status Code
-     *
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to update multiple objects.
      *
      * @generated from protobuf rpc: MultiUpdateObject(payload.v1.Update.MultiObjectRequest) returns (payload.v1.Object.Locations);
      */
@@ -243,16 +139,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * UpsertObject RPC is the method to update a single object and add a new single object.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to upsert object.
      *
      * @generated from protobuf rpc: UpsertObject(payload.v1.Upsert.ObjectRequest) returns (payload.v1.Object.Location);
      */
@@ -261,16 +148,7 @@ class FilterClient extends grpc.Client {
         return this.makeUnaryRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), input, metadata, options, callback);
     }
     /**
-     * Overview
-     * UpsertObject RPC is the method to update a single object and add a new single object.
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to upsert object by bidirectional streaming.
      *
      * @generated from protobuf rpc: StreamUpsertObject(stream payload.v1.Upsert.ObjectRequest) returns (stream payload.v1.Object.StreamLocation);
      */
@@ -279,21 +157,7 @@ class FilterClient extends grpc.Client {
         return this.makeBidiStreamRequest(`/${filter_pb_1.Filter.typeName}/${method.name}`, (value) => Buffer.from(method.I.toBinary(value, this._binaryOptions)), (value) => method.O.fromBinary(value, this._binaryOptions), metadata, options);
     }
     /**
-     * Overview
-     * MultiUpsertObject is the method to update existing multiple objects and add new multiple objects in **1** request.
-     *
-     * <div class="notice">
-     * gRPC has a message size limitation.<br>
-     * Please be careful that the size of the request exceeds the limit.
-     * </div>
-     * ---
-     * Status Code
-     * |  0   | OK                |
-     * |  1   | CANCELLED         |
-     * |  3   | INVALID_ARGUMENT  |
-     * |  4   | DEADLINE_EXCEEDED |
-     * |  6   | ALREADY_EXISTS    |
-     * |  13  | INTERNAL          |
+     * A method to upsert multiple objects.
      *
      * @generated from protobuf rpc: MultiUpsertObject(payload.v1.Upsert.MultiObjectRequest) returns (payload.v1.Object.Locations);
      */

diff --git a/src/vald/v1/vald/flush_pb.d.ts b/src/vald/v1/vald/flush_pb.d.ts
@@ -0,0 +1,26 @@
+/* eslint-disable */
+// @generated by protobuf-ts 2.9.4 with parameter add_pb_suffix,client_grpc1,generate_dependencies,keep_enum_prefix,ts_nocheck,use_proto_field_name,output_javascript,output_legacy_commonjs,eslint_disable
+// @generated from protobuf file "vald/v1/vald/flush.proto" (package "vald.v1", syntax proto3)
+// tslint:disable
+// @ts-nocheck
+//
+//
+// Copyright (C) 2019-2024 vdaas.org vald team <[email protected]>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//
+/**
+ * @generated ServiceType for protobuf service vald.v1.Flush
+ */
+export declare const Flush: any;