Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport PR #2778 to release/v1.7 for Fix format of proto files #2783

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Backport PR #2778 to release/v1.7 for Fix format of proto files #2783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions apis/proto/v1/vald/filter.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ option java_package = "org.vdaas.vald.api.v1.vald";

// 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.
service Filter {
// Overview
Expand Down Expand Up @@ -69,7 +69,7 @@ service Filter {

// 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.
Expand Down Expand Up @@ -103,7 +103,7 @@ service Filter {

// 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.
Expand Down Expand Up @@ -168,14 +168,14 @@ service Filter {

// 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 |
Expand Down Expand Up @@ -220,7 +220,7 @@ service Filter {

// 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.
Expand Down
4 changes: 2 additions & 2 deletions apis/proto/v1/vald/index.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ service Index {
rpc IndexInfo(payload.v1.Empty) returns (payload.v1.Info.Index.Count) {
option (google.api.http).get = "/index/info";
}

// Overview
// Represent the RPC to get the index information for each agents.
rpc IndexDetail(payload.v1.Empty) returns (payload.v1.Info.Index.Detail) {
option (google.api.http).get = "/index/detail";
}

// Overview
// Represent the RPC to get the index statistics.
rpc IndexStatistics(payload.v1.Empty) returns (payload.v1.Info.Index.Statistics) {
Expand Down
12 changes: 6 additions & 6 deletions apis/proto/v1/vald/insert.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ service Insert {
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand Down Expand Up @@ -76,9 +76,9 @@ service Insert {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand All @@ -90,7 +90,7 @@ service Insert {

// Overview
// MultiInsert RPC is the method to add multiple new vectors 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.
Expand All @@ -107,9 +107,9 @@ service Insert {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand Down
12 changes: 6 additions & 6 deletions apis/proto/v1/vald/object.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ service Object {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand All @@ -69,9 +69,9 @@ service Object {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand All @@ -98,9 +98,9 @@ service Object {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand Down
24 changes: 12 additions & 12 deletions apis/proto/v1/vald/remove.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ service Remove {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand All @@ -62,7 +62,7 @@ service Remove {

// Overview
// RemoveByTimestamp RPC is the method to remove vectors based on timestamp.
//
//
// <div class="notice">
// In the TimestampRequest message, the 'timestamps' field is repeated, allowing the inclusion of multiple Timestamp.<br>
// When multiple Timestamps are provided, it results in an `AND` condition, enabling the realization of deletions with specified ranges.<br>
Expand All @@ -78,15 +78,15 @@ service Remove {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
// | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. |
// | NOT_FOUND | No vectors in the system match the specified timestamp conditions. | Check whether vectors matching the specified timestamp conditions exist in the system, and fix conditions if needed. |
// | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second.
// | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second.
rpc RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations) {
option (google.api.http) = {
post: "/remove/timestamp"
Expand All @@ -96,7 +96,7 @@ service Remove {

// Overview
// A method to remove multiple indexed vectors by bidirectional streaming.
//
//
// StreamRemove RPC is the method to remove multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).<br>
// Using the bidirectional streaming RPC, the remove request can be communicated in any order between client and server.
// Each Remove request and response are independent.
Expand All @@ -113,9 +113,9 @@ service Remove {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand All @@ -127,7 +127,7 @@ service Remove {

// Overview
// MultiRemove is the method to remove multiple vectors 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.
Expand All @@ -144,9 +144,9 @@ service Remove {
// ---
// Troubleshooting
// The request process may not be completed when the response code is NOT `0 (OK)`.
//
//
// Here are some common reasons and how to resolve each error.
//
//
// | name | common reason | how to resolve |
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
Expand Down
Loading
Loading