Documentation
¶
Overview ¶
Package bleveproto contains the definition of the **specific GRPC protpcol** that is used between an SST Client and the Bleve part of an **SST Remote Repository**; both using the SST Core API.
Index ¶
- Constants
- Variables
- func NewSearchRequest(request *bleve.SearchRequest) ([]byte, error)
- func RegisterIndexServiceServer(s grpc.ServiceRegistrar, srv IndexServiceServer)
- type IndexServiceClient
- type IndexServiceServer
- type IndexService_SearchClient
- type IndexService_SearchServer
- type SearchRequest
- func (*SearchRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SearchRequest) GetRepoName() string
- func (x *SearchRequest) GetRequest() []byte
- func (*SearchRequest) ProtoMessage()
- func (x *SearchRequest) ProtoReflect() protoreflect.Message
- func (x *SearchRequest) Reset()
- func (x *SearchRequest) String() string
- type SearchResult
- func (*SearchResult) Descriptor() ([]byte, []int)deprecated
- func (x *SearchResult) GetResult() []byte
- func (*SearchResult) ProtoMessage()
- func (x *SearchResult) ProtoReflect() protoreflect.Message
- func (x *SearchResult) Reset()
- func (x *SearchResult) String() string
- func (r *SearchResult) ToSearchResult() (*bleve.SearchResult, error)
- type UnimplementedIndexServiceServer
- type UnsafeIndexServiceServer
Constants ¶
const (
IndexService_Search_FullMethodName = "/sst.ssquery.IndexService/Search"
)
Variables ¶
var File_index_proto protoreflect.FileDescriptor
var IndexService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "sst.ssquery.IndexService", HandlerType: (*IndexServiceServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "Search", Handler: _IndexService_Search_Handler, ClientStreams: true, }, }, Metadata: "index.proto", }
IndexService_ServiceDesc is the grpc.ServiceDesc for IndexService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func NewSearchRequest ¶
func NewSearchRequest(request *bleve.SearchRequest) ([]byte, error)
func RegisterIndexServiceServer ¶
func RegisterIndexServiceServer(s grpc.ServiceRegistrar, srv IndexServiceServer)
Types ¶
type IndexServiceClient ¶
type IndexServiceClient interface {
Search(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[SearchRequest, SearchResult], error)
}
IndexServiceClient is the client API for IndexService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewIndexServiceClient ¶
func NewIndexServiceClient(cc grpc.ClientConnInterface) IndexServiceClient
type IndexServiceServer ¶
type IndexServiceServer interface {
Search(grpc.ClientStreamingServer[SearchRequest, SearchResult]) error
// contains filtered or unexported methods
}
IndexServiceServer is the server API for IndexService service. All implementations must embed UnimplementedIndexServiceServer for forward compatibility.
type IndexService_SearchClient ¶
type IndexService_SearchClient = grpc.ClientStreamingClient[SearchRequest, SearchResult]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type IndexService_SearchServer ¶
type IndexService_SearchServer = grpc.ClientStreamingServer[SearchRequest, SearchResult]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type SearchRequest ¶
type SearchRequest struct {
Request []byte `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
RepoName string `protobuf:"bytes,2,opt,name=repoName,proto3" json:"repoName,omitempty"`
// contains filtered or unexported fields
}
func (*SearchRequest) Descriptor
deprecated
func (*SearchRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.
func (*SearchRequest) GetRepoName ¶
func (x *SearchRequest) GetRepoName() string
func (*SearchRequest) GetRequest ¶
func (x *SearchRequest) GetRequest() []byte
func (*SearchRequest) ProtoMessage ¶
func (*SearchRequest) ProtoMessage()
func (*SearchRequest) ProtoReflect ¶
func (x *SearchRequest) ProtoReflect() protoreflect.Message
func (*SearchRequest) Reset ¶
func (x *SearchRequest) Reset()
func (*SearchRequest) String ¶
func (x *SearchRequest) String() string
type SearchResult ¶
type SearchResult struct {
Result []byte `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
// contains filtered or unexported fields
}
func NewSearchResult ¶
func NewSearchResult(result *bleve.SearchResult) (*SearchResult, error)
func (*SearchResult) Descriptor
deprecated
func (*SearchResult) Descriptor() ([]byte, []int)
Deprecated: Use SearchResult.ProtoReflect.Descriptor instead.
func (*SearchResult) GetResult ¶
func (x *SearchResult) GetResult() []byte
func (*SearchResult) ProtoMessage ¶
func (*SearchResult) ProtoMessage()
func (*SearchResult) ProtoReflect ¶
func (x *SearchResult) ProtoReflect() protoreflect.Message
func (*SearchResult) Reset ¶
func (x *SearchResult) Reset()
func (*SearchResult) String ¶
func (x *SearchResult) String() string
func (*SearchResult) ToSearchResult ¶
func (r *SearchResult) ToSearchResult() (*bleve.SearchResult, error)
type UnimplementedIndexServiceServer ¶
type UnimplementedIndexServiceServer struct{}
UnimplementedIndexServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedIndexServiceServer) Search ¶
func (UnimplementedIndexServiceServer) Search(grpc.ClientStreamingServer[SearchRequest, SearchResult]) error
type UnsafeIndexServiceServer ¶
type UnsafeIndexServiceServer interface {
// contains filtered or unexported methods
}
UnsafeIndexServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to IndexServiceServer will result in compilation errors.
Source Files