index

package
v0.70.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 16, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Service_Create_FullMethodName               = "/index.v1.Service/Create"
	Service_CreateWithStreamData_FullMethodName = "/index.v1.Service/CreateWithStreamData"
	Service_Delete_FullMethodName               = "/index.v1.Service/Delete"
	Service_Get_FullMethodName                  = "/index.v1.Service/Get"
	Service_Put_FullMethodName                  = "/index.v1.Service/Put"
	Service_List_FullMethodName                 = "/index.v1.Service/List"
	Service_PatchRecords_FullMethodName         = "/index.v1.Service/PatchRecords"
	Service_ListRecords_FullMethodName          = "/index.v1.Service/ListRecords"
	Service_SearchRecords_FullMethodName        = "/index.v1.Service/SearchRecords"
)

Variables

View Source 
var File_index_proto protoreflect.FileDescriptor
View Source 
var Service_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "index.v1.Service",
	HandlerType: (*ServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _Service_Create_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Service_Delete_Handler,
		},
		{
			MethodName: "Get",
			Handler:    _Service_Get_Handler,
		},
		{
			MethodName: "Put",
			Handler:    _Service_Put_Handler,
		},
		{
			MethodName: "List",
			Handler:    _Service_List_Handler,
		},
		{
			MethodName: "PatchRecords",
			Handler:    _Service_PatchRecords_Handler,
		},
		{
			MethodName: "ListRecords",
			Handler:    _Service_ListRecords_Handler,
		},
		{
			MethodName: "SearchRecords",
			Handler:    _Service_SearchRecords_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "CreateWithStreamData",
			Handler:       _Service_CreateWithStreamData_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "index.proto",
}

Service_ServiceDesc is the grpc.ServiceDesc for Service service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterServiceServer 

func RegisterServiceServer(s grpc.ServiceRegistrar, srv ServiceServer)

Types

type CreateIndexRequest 

type CreateIndexRequest struct {

	// id contains the index identifier. It may be generated or provided. If provided, caller must
	// support it. id cannot be more than 256 bytes long
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// format name. Format must exist
	Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
	// tags associated with the index. May be empty.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// document contains the binary data for the format provided. It may be empty
	Document []byte `protobuf:"bytes,4,opt,name=document,proto3,oneof" json:"document,omitempty"`
	// records contains the list of records that can be added to the index when it is created
	Records []*Record `protobuf:"bytes,5,rep,name=records,proto3" json:"records,omitempty"`
	// contains filtered or unexported fields
}

CreateIndexRequest allows to create a new index

func (*CreateIndexRequest) Descriptor deprecated 

func (*CreateIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetDocument added in v0.6.0 

func (x *CreateIndexRequest) GetDocument() []byte

func (*CreateIndexRequest) GetFormat 

func (x *CreateIndexRequest) GetFormat() string

func (*CreateIndexRequest) GetId added in v0.6.0 

func (x *CreateIndexRequest) GetId() string

func (*CreateIndexRequest) GetRecords added in v0.6.0 

func (x *CreateIndexRequest) GetRecords() []*Record

func (*CreateIndexRequest) GetTags 

func (x *CreateIndexRequest) GetTags() map[string]string

func (*CreateIndexRequest) ProtoMessage 

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect 

func (x *CreateIndexRequest) ProtoReflect() protoreflect.Message

func (*CreateIndexRequest) Reset 

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String 

func (x *CreateIndexRequest) String() string

type CreateIndexStreamRequest added in v0.29.0 

type CreateIndexStreamRequest struct {

	// CreateIndexRequest must be in the first packet of the gRPC stream
	Meta *CreateIndexRequest `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// data is the body data, may start from the first packet of the stream
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

CreateIndexStreamRequest wraps CreateIndexRequest OR a chunk of body stream

func (*CreateIndexStreamRequest) Descriptor deprecated added in v0.29.0 

func (*CreateIndexStreamRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexStreamRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexStreamRequest) GetData added in v0.29.0 

func (x *CreateIndexStreamRequest) GetData() []byte

func (*CreateIndexStreamRequest) GetMeta added in v0.29.0 

func (x *CreateIndexStreamRequest) GetMeta() *CreateIndexRequest

func (*CreateIndexStreamRequest) ProtoMessage added in v0.29.0 

func (*CreateIndexStreamRequest) ProtoMessage()

func (*CreateIndexStreamRequest) ProtoReflect added in v0.29.0 

func (x *CreateIndexStreamRequest) ProtoReflect() protoreflect.Message

func (*CreateIndexStreamRequest) Reset added in v0.29.0 

func (x *CreateIndexStreamRequest) Reset()

func (*CreateIndexStreamRequest) String added in v0.29.0 

func (x *CreateIndexStreamRequest) String() string

type Id added in v0.6.0 

type Id struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Id allows to provide pure id for an entity

func (*Id) Descriptor deprecated added in v0.6.0 

func (*Id) Descriptor() ([]byte, []int)

Deprecated: Use Id.ProtoReflect.Descriptor instead.

func (*Id) GetId added in v0.6.0 

func (x *Id) GetId() string

func (*Id) ProtoMessage added in v0.6.0 

func (*Id) ProtoMessage()

func (*Id) ProtoReflect added in v0.6.0 

func (x *Id) ProtoReflect() protoreflect.Message

func (*Id) Reset added in v0.6.0 

func (x *Id) Reset()

func (*Id) String added in v0.6.0 

func (x *Id) String() string

type Index 

type Index struct {

	// id the index uniquely identifier
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// format - the index format
	Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
	// tags the list of key:value pairs associated with the index
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// createdAt the timestamp when the index was created
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=createdAt,proto3" json:"createdAt,omitempty"`
	// contains filtered or unexported fields
}

Index describes an index

func (*Index) Descriptor deprecated 

func (*Index) Descriptor() ([]byte, []int)

Deprecated: Use Index.ProtoReflect.Descriptor instead.

func (*Index) GetCreatedAt 

func (x *Index) GetCreatedAt() *timestamppb.Timestamp

func (*Index) GetFormat 

func (x *Index) GetFormat() string

func (*Index) GetId 

func (x *Index) GetId() string

func (*Index) GetTags 

func (x *Index) GetTags() map[string]string

func (*Index) ProtoMessage 

func (*Index) ProtoMessage()

func (*Index) ProtoReflect 

func (x *Index) ProtoReflect() protoreflect.Message

func (*Index) Reset 

func (x *Index) Reset()

func (*Index) String 

func (x *Index) String() string

type IndexRecord added in v0.6.0 

type IndexRecord struct {
	IndexId     string  `protobuf:"bytes,1,opt,name=indexId,proto3" json:"indexId,omitempty"`
	IndexRecord *Record `protobuf:"bytes,2,opt,name=indexRecord,proto3" json:"indexRecord,omitempty"`
	// contains filtered or unexported fields
}

IndexRecord describes a record for a specific index

func (*IndexRecord) Descriptor deprecated added in v0.6.0 

func (*IndexRecord) Descriptor() ([]byte, []int)

Deprecated: Use IndexRecord.ProtoReflect.Descriptor instead.

func (*IndexRecord) GetIndexId added in v0.6.0 

func (x *IndexRecord) GetIndexId() string

func (*IndexRecord) GetIndexRecord added in v0.6.0 

func (x *IndexRecord) GetIndexRecord() *Record

func (*IndexRecord) ProtoMessage added in v0.6.0 

func (*IndexRecord) ProtoMessage()

func (*IndexRecord) ProtoReflect added in v0.6.0 

func (x *IndexRecord) ProtoReflect() protoreflect.Message

func (*IndexRecord) Reset added in v0.6.0 

func (x *IndexRecord) Reset()

func (*IndexRecord) String added in v0.6.0 

func (x *IndexRecord) String() string

type Indexes added in v0.6.0 

type Indexes struct {

	// indexes contains the list of indexes
	Indexes []*Index `protobuf:"bytes,1,rep,name=indexes,proto3" json:"indexes,omitempty"`
	// nextIndexId is used for pagination
	NextIndexId *string `protobuf:"bytes,2,opt,name=nextIndexId,proto3,oneof" json:"nextIndexId,omitempty"`
	// total contains the total number of known indexes
	Total int64 `protobuf:"varint,3,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

Indexes describes the group of indexes. Used list operation.

func (*Indexes) Descriptor deprecated added in v0.6.0 

func (*Indexes) Descriptor() ([]byte, []int)

Deprecated: Use Indexes.ProtoReflect.Descriptor instead.

func (*Indexes) GetIndexes added in v0.6.0 

func (x *Indexes) GetIndexes() []*Index

func (*Indexes) GetNextIndexId added in v0.6.0 

func (x *Indexes) GetNextIndexId() string

func (*Indexes) GetTotal added in v0.6.0 

func (x *Indexes) GetTotal() int64

func (*Indexes) ProtoMessage added in v0.6.0 

func (*Indexes) ProtoMessage()

func (*Indexes) ProtoReflect added in v0.6.0 

func (x *Indexes) ProtoReflect() protoreflect.Message

func (*Indexes) Reset added in v0.6.0 

func (x *Indexes) Reset()

func (*Indexes) String added in v0.6.0 

func (x *Indexes) String() string

type ListRecordsRequest added in v0.6.0 

type ListRecordsRequest struct {

	// id is the requested index id
	Id            string  `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	StartRecordId *string `protobuf:"bytes,2,opt,name=startRecordId,proto3,oneof" json:"startRecordId,omitempty"`
	Limit         *int64  `protobuf:"varint,3,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

ListRecordsRequest describes input parameters for list of records for a specific index operation

func (*ListRecordsRequest) Descriptor deprecated added in v0.6.0 

func (*ListRecordsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRecordsRequest.ProtoReflect.Descriptor instead.

func (*ListRecordsRequest) GetId added in v0.6.0 

func (x *ListRecordsRequest) GetId() string

func (*ListRecordsRequest) GetLimit added in v0.6.0 

func (x *ListRecordsRequest) GetLimit() int64

func (*ListRecordsRequest) GetStartRecordId added in v0.6.0 

func (x *ListRecordsRequest) GetStartRecordId() string

func (*ListRecordsRequest) ProtoMessage added in v0.6.0 

func (*ListRecordsRequest) ProtoMessage()

func (*ListRecordsRequest) ProtoReflect added in v0.6.0 

func (x *ListRecordsRequest) ProtoReflect() protoreflect.Message

func (*ListRecordsRequest) Reset added in v0.6.0 

func (x *ListRecordsRequest) Reset()

func (*ListRecordsRequest) String added in v0.6.0 

func (x *ListRecordsRequest) String() string

type ListRecordsResult added in v0.6.0 

type ListRecordsResult struct {
	Records      []*Record `protobuf:"bytes,1,rep,name=records,proto3" json:"records,omitempty"`
	NextRecordId *string   `protobuf:"bytes,2,opt,name=nextRecordId,proto3,oneof" json:"nextRecordId,omitempty"`
	Total        int64     `protobuf:"varint,3,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRecordsResult) Descriptor deprecated added in v0.6.0 

func (*ListRecordsResult) Descriptor() ([]byte, []int)

Deprecated: Use ListRecordsResult.ProtoReflect.Descriptor instead.

func (*ListRecordsResult) GetNextRecordId added in v0.6.0 

func (x *ListRecordsResult) GetNextRecordId() string

func (*ListRecordsResult) GetRecords added in v0.6.0 

func (x *ListRecordsResult) GetRecords() []*Record

func (*ListRecordsResult) GetTotal added in v0.23.0 

func (x *ListRecordsResult) GetTotal() int64

func (*ListRecordsResult) ProtoMessage added in v0.6.0 

func (*ListRecordsResult) ProtoMessage()

func (*ListRecordsResult) ProtoReflect added in v0.6.0 

func (x *ListRecordsResult) ProtoReflect() protoreflect.Message

func (*ListRecordsResult) Reset added in v0.6.0 

func (x *ListRecordsResult) Reset()

func (*ListRecordsResult) String added in v0.6.0 

func (x *ListRecordsResult) String() string

type ListRequest added in v0.6.0 

type ListRequest struct {
	StartIndexId  string                 `protobuf:"bytes,1,opt,name=startIndexId,proto3" json:"startIndexId,omitempty"`
	Format        *string                `protobuf:"bytes,2,opt,name=format,proto3,oneof" json:"format,omitempty"`
	Tags          map[string]string      `` /* 149-byte string literal not displayed */
	CreatedAfter  *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=createdAfter,proto3,oneof" json:"createdAfter,omitempty"`
	CreatedBefore *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=createdBefore,proto3,oneof" json:"createdBefore,omitempty"`
	Limit         *int64                 `protobuf:"varint,6,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

ListRequest describes input parameters for the list indexes operation

func (*ListRequest) Descriptor deprecated added in v0.6.0 

func (*ListRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetCreatedAfter added in v0.6.0 

func (x *ListRequest) GetCreatedAfter() *timestamppb.Timestamp

func (*ListRequest) GetCreatedBefore added in v0.6.0 

func (x *ListRequest) GetCreatedBefore() *timestamppb.Timestamp

func (*ListRequest) GetFormat added in v0.6.0 

func (x *ListRequest) GetFormat() string

func (*ListRequest) GetLimit added in v0.6.0 

func (x *ListRequest) GetLimit() int64

func (*ListRequest) GetStartIndexId added in v0.6.0 

func (x *ListRequest) GetStartIndexId() string

func (*ListRequest) GetTags added in v0.6.0 

func (x *ListRequest) GetTags() map[string]string

func (*ListRequest) ProtoMessage added in v0.6.0 

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect added in v0.6.0 

func (x *ListRequest) ProtoReflect() protoreflect.Message

func (*ListRequest) Reset added in v0.6.0 

func (x *ListRequest) Reset()

func (*ListRequest) String added in v0.6.0 

func (x *ListRequest) String() string

type PatchRecordsRequest added in v0.6.0 

type PatchRecordsRequest struct {

	// id is the patched index id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// upsertRecords contains the list of records that should be inserted or updated
	UpsertRecords []*Record `protobuf:"bytes,2,rep,name=upsertRecords,proto3" json:"upsertRecords,omitempty"`
	// deleteRecords contains the list of records that should be deleted
	DeleteRecords []*Record `protobuf:"bytes,3,rep,name=deleteRecords,proto3" json:"deleteRecords,omitempty"`
	// contains filtered or unexported fields
}

PatchRecordsRequest describes input parameters for index records patch operation.

func (*PatchRecordsRequest) Descriptor deprecated added in v0.6.0 

func (*PatchRecordsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PatchRecordsRequest.ProtoReflect.Descriptor instead.

func (*PatchRecordsRequest) GetDeleteRecords added in v0.6.0 

func (x *PatchRecordsRequest) GetDeleteRecords() []*Record

func (*PatchRecordsRequest) GetId added in v0.6.0 

func (x *PatchRecordsRequest) GetId() string

func (*PatchRecordsRequest) GetUpsertRecords added in v0.6.0 

func (x *PatchRecordsRequest) GetUpsertRecords() []*Record

func (*PatchRecordsRequest) ProtoMessage added in v0.6.0 

func (*PatchRecordsRequest) ProtoMessage()

func (*PatchRecordsRequest) ProtoReflect added in v0.6.0 

func (x *PatchRecordsRequest) ProtoReflect() protoreflect.Message

func (*PatchRecordsRequest) Reset added in v0.6.0 

func (x *PatchRecordsRequest) Reset()

func (*PatchRecordsRequest) String added in v0.6.0 

func (x *PatchRecordsRequest) String() string

type PatchRecordsResult added in v0.6.0 

type PatchRecordsResult struct {
	Upserted int64 `protobuf:"varint,1,opt,name=upserted,proto3" json:"upserted,omitempty"`
	Deleted  int64 `protobuf:"varint,2,opt,name=deleted,proto3" json:"deleted,omitempty"`
	// contains filtered or unexported fields
}

PatchRecordsResult describes the result of the patch index's records operation

func (*PatchRecordsResult) Descriptor deprecated added in v0.6.0 

func (*PatchRecordsResult) Descriptor() ([]byte, []int)

Deprecated: Use PatchRecordsResult.ProtoReflect.Descriptor instead.

func (*PatchRecordsResult) GetDeleted added in v0.6.0 

func (x *PatchRecordsResult) GetDeleted() int64

func (*PatchRecordsResult) GetUpserted added in v0.23.0 

func (x *PatchRecordsResult) GetUpserted() int64

func (*PatchRecordsResult) ProtoMessage added in v0.6.0 

func (*PatchRecordsResult) ProtoMessage()

func (*PatchRecordsResult) ProtoReflect added in v0.6.0 

func (x *PatchRecordsResult) ProtoReflect() protoreflect.Message

func (*PatchRecordsResult) Reset added in v0.6.0 

func (x *PatchRecordsResult) Reset()

func (*PatchRecordsResult) String added in v0.6.0 

func (x *PatchRecordsResult) String() string

type Record added in v0.6.0 

type Record struct {

	// id is the record id - this field is populated by parser or it is provided when records are created.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// segment contains the searchable text for the record
	Segment string `protobuf:"bytes,2,opt,name=segment,proto3" json:"segment,omitempty"`
	// vector is the list of the byte values (stringified) ordered according the basis fields definition
	Vector []byte `protobuf:"bytes,3,opt,name=vector,proto3" json:"vector,omitempty"`
	// contains filtered or unexported fields
}

Record represents an index record

func (*Record) Descriptor deprecated added in v0.6.0 

func (*Record) Descriptor() ([]byte, []int)

Deprecated: Use Record.ProtoReflect.Descriptor instead.

func (*Record) GetId added in v0.6.0 

func (x *Record) GetId() string

func (*Record) GetSegment added in v0.6.0 

func (x *Record) GetSegment() string

func (*Record) GetVector added in v0.6.0 

func (x *Record) GetVector() []byte

func (*Record) ProtoMessage added in v0.6.0 

func (*Record) ProtoMessage()

func (*Record) ProtoReflect added in v0.6.0 

func (x *Record) ProtoReflect() protoreflect.Message

func (*Record) Reset added in v0.6.0 

func (x *Record) Reset()

func (*Record) String added in v0.6.0 

func (x *Record) String() string

type SearchRecordsRequest added in v0.6.0 

type SearchRecordsRequest struct {
	Text     string            `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	Tags     map[string]string `` /* 149-byte string literal not displayed */
	IndexIDs []string          `protobuf:"bytes,3,rep,name=indexIDs,proto3" json:"indexIDs,omitempty"`
	// distinct - if it is true and specified the result will contain only one record(first) per index,
	// even if the index contains multiple places where the text is found. If the parameter is false,
	// or not specified, the result set will contain all found places for each index.
	Distinct *bool `protobuf:"varint,4,opt,name=distinct,proto3,oneof" json:"distinct,omitempty"`
	// orderByScore - if true the results are ordered by the result relevancy score. No cursor pagination
	// is supported in this case (no "nextPageId" is returned in the result), the "offset" could be used to
	// get the next page results.
	OrderByScore *bool   `protobuf:"varint,5,opt,name=orderByScore,proto3,oneof" json:"orderByScore,omitempty"`
	PageId       *string `protobuf:"bytes,6,opt,name=pageId,proto3,oneof" json:"pageId,omitempty"`
	// offset specifies how many records to skip before beginning to return records.
	// This parameter must be used with care since it just "skips records" (the full scan)
	// thus it is not very performant and may create a significant load.
	Offset *int64 `protobuf:"varint,7,opt,name=offset,proto3,oneof" json:"offset,omitempty"`
	// limit specifies the maximum number of records in the result set
	Limit *int64 `protobuf:"varint,8,opt,name=limit,proto3,oneof" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

SearchRecordsRequest describes input parameters for the Search over indexes operation.

func (*SearchRecordsRequest) Descriptor deprecated added in v0.6.0 

func (*SearchRecordsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchRecordsRequest.ProtoReflect.Descriptor instead.

func (*SearchRecordsRequest) GetDistinct added in v0.6.0 

func (x *SearchRecordsRequest) GetDistinct() bool

func (*SearchRecordsRequest) GetIndexIDs added in v0.6.0 

func (x *SearchRecordsRequest) GetIndexIDs() []string

func (*SearchRecordsRequest) GetLimit added in v0.6.0 

func (x *SearchRecordsRequest) GetLimit() int64

func (*SearchRecordsRequest) GetOffset added in v0.31.0 

func (x *SearchRecordsRequest) GetOffset() int64

func (*SearchRecordsRequest) GetOrderByScore added in v0.31.0 

func (x *SearchRecordsRequest) GetOrderByScore() bool

func (*SearchRecordsRequest) GetPageId added in v0.6.0 

func (x *SearchRecordsRequest) GetPageId() string

func (*SearchRecordsRequest) GetTags added in v0.6.0 

func (x *SearchRecordsRequest) GetTags() map[string]string

func (*SearchRecordsRequest) GetText added in v0.6.0 

func (x *SearchRecordsRequest) GetText() string

func (*SearchRecordsRequest) ProtoMessage added in v0.6.0 

func (*SearchRecordsRequest) ProtoMessage()

func (*SearchRecordsRequest) ProtoReflect added in v0.6.0 

func (x *SearchRecordsRequest) ProtoReflect() protoreflect.Message

func (*SearchRecordsRequest) Reset added in v0.6.0 

func (x *SearchRecordsRequest) Reset()

func (*SearchRecordsRequest) String added in v0.6.0 

func (x *SearchRecordsRequest) String() string

type SearchRecordsResult added in v0.6.0 

type SearchRecordsResult struct {
	Items      []*SearchRecordsResultItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	NextPageId *string                    `protobuf:"bytes,2,opt,name=nextPageId,proto3,oneof" json:"nextPageId,omitempty"`
	Total      int64                      `protobuf:"varint,3,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

SearchRecordsResult contains the result of a search operation

func (*SearchRecordsResult) Descriptor deprecated added in v0.6.0 

func (*SearchRecordsResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchRecordsResult.ProtoReflect.Descriptor instead.

func (*SearchRecordsResult) GetItems added in v0.31.0 

func (x *SearchRecordsResult) GetItems() []*SearchRecordsResultItem

func (*SearchRecordsResult) GetNextPageId added in v0.6.0 

func (x *SearchRecordsResult) GetNextPageId() string

func (*SearchRecordsResult) GetTotal added in v0.23.0 

func (x *SearchRecordsResult) GetTotal() int64

func (*SearchRecordsResult) ProtoMessage added in v0.6.0 

func (*SearchRecordsResult) ProtoMessage()

func (*SearchRecordsResult) ProtoReflect added in v0.6.0 

func (x *SearchRecordsResult) ProtoReflect() protoreflect.Message

func (*SearchRecordsResult) Reset added in v0.6.0 

func (x *SearchRecordsResult) Reset()

func (*SearchRecordsResult) String added in v0.6.0 

func (x *SearchRecordsResult) String() string

type SearchRecordsResultItem added in v0.31.0 

type SearchRecordsResultItem struct {
	IndexId         string   `protobuf:"bytes,1,opt,name=indexId,proto3" json:"indexId,omitempty"`
	IndexRecord     *Record  `protobuf:"bytes,2,opt,name=indexRecord,proto3" json:"indexRecord,omitempty"`
	MatchedKeywords []string `protobuf:"bytes,3,rep,name=MatchedKeywords,proto3" json:"MatchedKeywords,omitempty"`
	Score           *float32 `protobuf:"fixed32,4,opt,name=score,proto3,oneof" json:"score,omitempty"`
	// contains filtered or unexported fields
}

SearchRecordsResultItem describes search records result item

func (*SearchRecordsResultItem) Descriptor deprecated added in v0.31.0 

func (*SearchRecordsResultItem) Descriptor() ([]byte, []int)

Deprecated: Use SearchRecordsResultItem.ProtoReflect.Descriptor instead.

func (*SearchRecordsResultItem) GetIndexId added in v0.31.0 

func (x *SearchRecordsResultItem) GetIndexId() string

func (*SearchRecordsResultItem) GetIndexRecord added in v0.31.0 

func (x *SearchRecordsResultItem) GetIndexRecord() *Record

func (*SearchRecordsResultItem) GetMatchedKeywords added in v0.37.0 

func (x *SearchRecordsResultItem) GetMatchedKeywords() []string

func (*SearchRecordsResultItem) GetScore added in v0.31.0 

func (x *SearchRecordsResultItem) GetScore() float32

func (*SearchRecordsResultItem) ProtoMessage added in v0.31.0 

func (*SearchRecordsResultItem) ProtoMessage()

func (*SearchRecordsResultItem) ProtoReflect added in v0.31.0 

func (x *SearchRecordsResultItem) ProtoReflect() protoreflect.Message

func (*SearchRecordsResultItem) Reset added in v0.31.0 

func (x *SearchRecordsResultItem) Reset()

func (*SearchRecordsResultItem) String added in v0.31.0 

func (x *SearchRecordsResultItem) String() string

type ServiceClient 

type ServiceClient interface {
	// Create allows to create a new index.
	Create(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*Index, error)
	// Create allows to create a new index, streaming the records data in the request
	CreateWithStreamData(ctx context.Context, opts ...grpc.CallOption) (Service_CreateWithStreamDataClient, error)
	// Delete allows to remove an index by its id
	Delete(ctx context.Context, in *Id, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Get returns information about the index
	Get(ctx context.Context, in *Id, opts ...grpc.CallOption) (*Index, error)
	// Put allows to update the index tags
	Put(ctx context.Context, in *Index, opts ...grpc.CallOption) (*Index, error)
	// List returns list of known indexes
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*Indexes, error)
	// PatchRecords allows to insert, update or delete an index's records
	PatchRecords(ctx context.Context, in *PatchRecordsRequest, opts ...grpc.CallOption) (*PatchRecordsResult, error)
	// ListRecords returns list of records for an index
	ListRecords(ctx context.Context, in *ListRecordsRequest, opts ...grpc.CallOption) (*ListRecordsResult, error)
	// SearchRecords runs the search across all indexes by the specified query. Result will
	// be ordered by indexID:recordID order
	SearchRecords(ctx context.Context, in *SearchRecordsRequest, opts ...grpc.CallOption) (*SearchRecordsResult, error)
}

ServiceClient is the client API for Service 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 NewServiceClient 

func NewServiceClient(cc grpc.ClientConnInterface) ServiceClient

type ServiceServer 

type ServiceServer interface {
	// Create allows to create a new index.
	Create(context.Context, *CreateIndexRequest) (*Index, error)
	// Create allows to create a new index, streaming the records data in the request
	CreateWithStreamData(Service_CreateWithStreamDataServer) error
	// Delete allows to remove an index by its id
	Delete(context.Context, *Id) (*emptypb.Empty, error)
	// Get returns information about the index
	Get(context.Context, *Id) (*Index, error)
	// Put allows to update the index tags
	Put(context.Context, *Index) (*Index, error)
	// List returns list of known indexes
	List(context.Context, *ListRequest) (*Indexes, error)
	// PatchRecords allows to insert, update or delete an index's records
	PatchRecords(context.Context, *PatchRecordsRequest) (*PatchRecordsResult, error)
	// ListRecords returns list of records for an index
	ListRecords(context.Context, *ListRecordsRequest) (*ListRecordsResult, error)
	// SearchRecords runs the search across all indexes by the specified query. Result will
	// be ordered by indexID:recordID order
	SearchRecords(context.Context, *SearchRecordsRequest) (*SearchRecordsResult, error)
	// contains filtered or unexported methods
}

ServiceServer is the server API for Service service. All implementations must embed UnimplementedServiceServer for forward compatibility

type Service_CreateWithStreamDataClient added in v0.29.0 

type Service_CreateWithStreamDataClient interface {
	Send(*CreateIndexStreamRequest) error
	CloseAndRecv() (*Index, error)
	grpc.ClientStream
}

type Service_CreateWithStreamDataServer added in v0.29.0 

type Service_CreateWithStreamDataServer interface {
	SendAndClose(*Index) error
	Recv() (*CreateIndexStreamRequest, error)
	grpc.ServerStream
}

type UnimplementedServiceServer 

type UnimplementedServiceServer struct {
}

UnimplementedServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedServiceServer) Create 

func (UnimplementedServiceServer) Create(context.Context, *CreateIndexRequest) (*Index, error)

func (UnimplementedServiceServer) CreateWithStreamData added in v0.29.0 

func (UnimplementedServiceServer) CreateWithStreamData(Service_CreateWithStreamDataServer) error

func (UnimplementedServiceServer) Delete added in v0.6.0 

func (UnimplementedServiceServer) Delete(context.Context, *Id) (*emptypb.Empty, error)

func (UnimplementedServiceServer) Get added in v0.6.0 

func (UnimplementedServiceServer) Get(context.Context, *Id) (*Index, error)

func (UnimplementedServiceServer) List added in v0.6.0 

func (UnimplementedServiceServer) List(context.Context, *ListRequest) (*Indexes, error)

func (UnimplementedServiceServer) ListRecords added in v0.6.0 

func (UnimplementedServiceServer) ListRecords(context.Context, *ListRecordsRequest) (*ListRecordsResult, error)

func (UnimplementedServiceServer) PatchRecords added in v0.6.0 

func (UnimplementedServiceServer) PatchRecords(context.Context, *PatchRecordsRequest) (*PatchRecordsResult, error)

func (UnimplementedServiceServer) Put added in v0.6.0 

func (UnimplementedServiceServer) Put(context.Context, *Index) (*Index, error)

func (UnimplementedServiceServer) SearchRecords added in v0.6.0 

func (UnimplementedServiceServer) SearchRecords(context.Context, *SearchRecordsRequest) (*SearchRecordsResult, error)

type UnsafeServiceServer 

type UnsafeServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.