index

package
v0.104.0 Latest Latest
Warning

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

 Go to latest Published: Jan 5, 2024 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_UpdateNode_FullMethodName           = "/index.v1.Service/UpdateNode"
	Service_DeleteNodes_FullMethodName          = "/index.v1.Service/DeleteNodes"
	Service_ListNodes_FullMethodName            = "/index.v1.Service/ListNodes"
	Service_PatchRecords_FullMethodName         = "/index.v1.Service/PatchRecords"
	Service_ListRecords_FullMethodName          = "/index.v1.Service/ListRecords"
	Service_Search_FullMethodName               = "/index.v1.Service/Search"
)

Variables

View Source 
var (
	NodeType_name = map[int32]string{
		0: "FOLDER",
		1: "DOCUMENT",
	}
	NodeType_value = map[string]int32{
		"FOLDER":   0,
		"DOCUMENT": 1,
	}
)

Enum value maps for NodeType.

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: "UpdateNode",
			Handler:    _Service_UpdateNode_Handler,
		},
		{
			MethodName: "DeleteNodes",
			Handler:    _Service_DeleteNodes_Handler,
		},
		{
			MethodName: "ListNodes",
			Handler:    _Service_ListNodes_Handler,
		},
		{
			MethodName: "PatchRecords",
			Handler:    _Service_PatchRecords_Handler,
		},
		{
			MethodName: "ListRecords",
			Handler:    _Service_ListRecords_Handler,
		},
		{
			MethodName: "Search",
			Handler:    _Service_Search_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 CreateIndexStreamRequest added in v0.29.0 

type CreateIndexStreamRequest struct {

	// CreateRecordsRequest must be in the first packet of the gRPC stream
	Meta *CreateRecordsRequest `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() *CreateRecordsRequest

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 CreateRecordsRequest added in v0.80.0 

type CreateRecordsRequest struct {

	// path contains the path to a node the all records will be associated with. If one or several
	// nodes in the path do not exist, they will be created automatically with folder type.
	// path cannot contain "document" nodes in the middle, but last one.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// nodeType contains the node type the records will be added to if it will be created during the call.
	// This is the last name in the path and if it doesn't exist, it will be created with the type
	NodeType *NodeType `protobuf:"varint,2,opt,name=nodeType,proto3,enum=index.v1.NodeType,oneof" json:"nodeType,omitempty"`
	// tags associated with the new node. If it is empty, no changes in the tags for the node.
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// parser, which will be used for the document body. Actually it is the format name
	Parser *string `protobuf:"bytes,4,opt,name=parser,proto3,oneof" json:"parser,omitempty"`
	// document contains the binary data for the parser provided. It may be empty
	Document []byte `protobuf:"bytes,5,opt,name=document,proto3,oneof" json:"document,omitempty"`
	// records contains the list of records that can be added additionally to the document
	Records []*Record `protobuf:"bytes,6,rep,name=records,proto3" json:"records,omitempty"`
	// rankMultiplier must be >= 1.0 and defines the priority of the records if the parser is used or no this field in the records list
	RankMultiplier float32 `protobuf:"fixed32,7,opt,name=rankMultiplier,proto3" json:"rankMultiplier,omitempty"`
	// contains filtered or unexported fields
}

CreateRecordsRequest is used for the creation of the new index records.

func (*CreateRecordsRequest) Descriptor deprecated added in v0.80.0 

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

Deprecated: Use CreateRecordsRequest.ProtoReflect.Descriptor instead.

func (*CreateRecordsRequest) GetDocument added in v0.80.0 

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

func (*CreateRecordsRequest) GetNodeType added in v0.80.0 

func (x *CreateRecordsRequest) GetNodeType() NodeType

func (*CreateRecordsRequest) GetParser added in v0.80.0 

func (x *CreateRecordsRequest) GetParser() string

func (*CreateRecordsRequest) GetPath added in v0.80.0 

func (x *CreateRecordsRequest) GetPath() string

func (*CreateRecordsRequest) GetRankMultiplier added in v0.80.0 

func (x *CreateRecordsRequest) GetRankMultiplier() float32

func (*CreateRecordsRequest) GetRecords added in v0.80.0 

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

func (*CreateRecordsRequest) GetTags added in v0.80.0 

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

func (*CreateRecordsRequest) ProtoMessage added in v0.80.0 

func (*CreateRecordsRequest) ProtoMessage()

func (*CreateRecordsRequest) ProtoReflect added in v0.80.0 

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

func (*CreateRecordsRequest) Reset added in v0.80.0 

func (x *CreateRecordsRequest) Reset()

func (*CreateRecordsRequest) String added in v0.80.0 

func (x *CreateRecordsRequest) String() string

type CreateRecordsResult added in v0.80.0 

type CreateRecordsResult struct {
	NodesCreated   *Nodes `protobuf:"bytes,1,opt,name=nodesCreated,proto3" json:"nodesCreated,omitempty"`
	RecordsCreated int64  `protobuf:"varint,2,opt,name=recordsCreated,proto3" json:"recordsCreated,omitempty"`
	// contains filtered or unexported fields
}

CreateRecordsResult describes the result of the Create call

func (*CreateRecordsResult) Descriptor deprecated added in v0.80.0 

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

Deprecated: Use CreateRecordsResult.ProtoReflect.Descriptor instead.

func (*CreateRecordsResult) GetNodesCreated added in v0.80.0 

func (x *CreateRecordsResult) GetNodesCreated() *Nodes

func (*CreateRecordsResult) GetRecordsCreated added in v0.80.0 

func (x *CreateRecordsResult) GetRecordsCreated() int64

func (*CreateRecordsResult) ProtoMessage added in v0.80.0 

func (*CreateRecordsResult) ProtoMessage()

func (*CreateRecordsResult) ProtoReflect added in v0.80.0 

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

func (*CreateRecordsResult) Reset added in v0.80.0 

func (x *CreateRecordsResult) Reset()

func (*CreateRecordsResult) String added in v0.80.0 

func (x *CreateRecordsResult) String() string

type DeleteNodesRequest added in v0.98.0 

type DeleteNodesRequest struct {

	// filterConditions is used to select nodes. It cannot be empty
	FilterConditions string `protobuf:"bytes,1,opt,name=filterConditions,proto3" json:"filterConditions,omitempty"`
	// force flag defines that children for a selected node maybe returned even if they
	// don't meet the filter conditions.
	Force *bool `protobuf:"varint,2,opt,name=force,proto3,oneof" json:"force,omitempty"`
	// contains filtered or unexported fields
}

DelecteNodesRequest is used for deleting multiple nodes and their records

func (*DeleteNodesRequest) Descriptor deprecated added in v0.98.0 

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

Deprecated: Use DeleteNodesRequest.ProtoReflect.Descriptor instead.

func (*DeleteNodesRequest) GetFilterConditions added in v0.98.0 

func (x *DeleteNodesRequest) GetFilterConditions() string

func (*DeleteNodesRequest) GetForce added in v0.98.0 

func (x *DeleteNodesRequest) GetForce() bool

func (*DeleteNodesRequest) ProtoMessage added in v0.98.0 

func (*DeleteNodesRequest) ProtoMessage()

func (*DeleteNodesRequest) ProtoReflect added in v0.98.0 

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

func (*DeleteNodesRequest) Reset added in v0.98.0 

func (x *DeleteNodesRequest) Reset()

func (*DeleteNodesRequest) String added in v0.98.0 

func (x *DeleteNodesRequest) String() string

type ListNodesRequest added in v0.100.0 

type ListNodesRequest struct {

	// filterConditions is used to select nodes. It cannot be empty
	FilterConditions string `protobuf:"bytes,1,opt,name=filterConditions,proto3" json:"filterConditions,omitempty"`
	Offset           int64  `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
	Limit            int64  `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

ListNodesRequest allows to request some nodes by the condition

func (*ListNodesRequest) Descriptor deprecated added in v0.100.0 

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

Deprecated: Use ListNodesRequest.ProtoReflect.Descriptor instead.

func (*ListNodesRequest) GetFilterConditions added in v0.100.0 

func (x *ListNodesRequest) GetFilterConditions() string

func (*ListNodesRequest) GetLimit added in v0.100.0 

func (x *ListNodesRequest) GetLimit() int64

func (*ListNodesRequest) GetOffset added in v0.100.0 

func (x *ListNodesRequest) GetOffset() int64

func (*ListNodesRequest) ProtoMessage added in v0.100.0 

func (*ListNodesRequest) ProtoMessage()

func (*ListNodesRequest) ProtoReflect added in v0.100.0 

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

func (*ListNodesRequest) Reset added in v0.100.0 

func (x *ListNodesRequest) Reset()

func (*ListNodesRequest) String added in v0.100.0 

func (x *ListNodesRequest) String() string

type ListRecordsResult added in v0.6.0 

type ListRecordsResult struct {
	Records    []*Record `protobuf:"bytes,1,rep,name=records,proto3" json:"records,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
}

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

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

Deprecated: Use ListRecordsResult.ProtoReflect.Descriptor instead.

func (*ListRecordsResult) GetNextPageId added in v0.80.0 

func (x *ListRecordsResult) GetNextPageId() 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 {

	// path to the node, for which records to be listed
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// format contains filter for specific records format
	Format        *string                `protobuf:"bytes,2,opt,name=format,proto3,oneof" json:"format,omitempty"`
	PageId        *string                `protobuf:"bytes,3,opt,name=pageId,proto3,oneof" json:"pageId,omitempty"`
	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 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) GetPageId added in v0.80.0 

func (x *ListRequest) GetPageId() string

func (*ListRequest) GetPath added in v0.80.0 

func (x *ListRequest) GetPath() 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 Node added in v0.80.0 

type Node struct {

	// path to the node
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// name is the identifier of the node on the level of the tree. Name must be unique among the children of the same
	// node.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// type of the node
	Type NodeType `protobuf:"varint,3,opt,name=type,proto3,enum=index.v1.NodeType" json:"type,omitempty"`
	// tags defines the tags associated with the object
	Tags map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Node) Descriptor deprecated added in v0.80.0 

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

Deprecated: Use Node.ProtoReflect.Descriptor instead.

func (*Node) GetName added in v0.80.0 

func (x *Node) GetName() string

func (*Node) GetPath added in v0.80.0 

func (x *Node) GetPath() string

func (*Node) GetTags added in v0.80.0 

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

func (*Node) GetType added in v0.80.0 

func (x *Node) GetType() NodeType

func (*Node) ProtoMessage added in v0.80.0 

func (*Node) ProtoMessage()

func (*Node) ProtoReflect added in v0.80.0 

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

func (*Node) Reset added in v0.80.0 

func (x *Node) Reset()

func (*Node) String added in v0.80.0 

func (x *Node) String() string

type NodeType added in v0.80.0 

type NodeType int32
const (
	NodeType_FOLDER   NodeType = 0
	NodeType_DOCUMENT NodeType = 1
)

func (NodeType) Descriptor added in v0.80.0 

func (NodeType) Descriptor() protoreflect.EnumDescriptor

func (NodeType) Enum added in v0.80.0 

func (x NodeType) Enum() *NodeType

func (NodeType) EnumDescriptor deprecated added in v0.80.0 

func (NodeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use NodeType.Descriptor instead.

func (NodeType) Number added in v0.80.0 

func (x NodeType) Number() protoreflect.EnumNumber

func (NodeType) String added in v0.80.0 

func (x NodeType) String() string

func (NodeType) Type added in v0.80.0 

func (NodeType) Type() protoreflect.EnumType

type Nodes added in v0.80.0 

type Nodes struct {
	Nodes []*Node `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// contains filtered or unexported fields
}

func (*Nodes) Descriptor deprecated added in v0.80.0 

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

Deprecated: Use Nodes.ProtoReflect.Descriptor instead.

func (*Nodes) GetNodes added in v0.80.0 

func (x *Nodes) GetNodes() []*Node

func (*Nodes) ProtoMessage added in v0.80.0 

func (*Nodes) ProtoMessage()

func (*Nodes) ProtoReflect added in v0.80.0 

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

func (*Nodes) Reset added in v0.80.0 

func (x *Nodes) Reset()

func (*Nodes) String added in v0.80.0 

func (x *Nodes) String() string

type PatchRecordsRequest added in v0.6.0 

type PatchRecordsRequest struct {

	// path is the path to the node for the patch request
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,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) GetPath added in v0.80.0 

func (x *PatchRecordsRequest) GetPath() 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 of the record within the node. This value is created by parser or during the records insertion.
	// it is used for the updating records or deleting them within a node
	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"`
	// format of the record
	Format string `protobuf:"bytes,4,opt,name=format,proto3" json:"format,omitempty"`
	// rankMultiplier must be >= 1.0 and defines the priority of the records if the parser is used or no this field in the records list
	RankMultiplier float32 `protobuf:"fixed32,5,opt,name=rankMultiplier,proto3" json:"rankMultiplier,omitempty"`
	// contains filtered or unexported fields
}

Record represents the index record

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

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

Deprecated: Use Record.ProtoReflect.Descriptor instead.

func (*Record) GetFormat added in v0.80.0 

func (x *Record) GetFormat() string

func (*Record) GetId added in v0.6.0 

func (x *Record) GetId() string

func (*Record) GetRankMultiplier added in v0.80.0 

func (x *Record) GetRankMultiplier() float32

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 {
	TextQuery        string `protobuf:"bytes,1,opt,name=textQuery,proto3" json:"textQuery,omitempty"`
	FilterConditions string `protobuf:"bytes,2,opt,name=filterConditions,proto3" json:"filterConditions,omitempty"`
	// The flag turns off results grouping by path.
	GroupByPathOff *bool  `protobuf:"varint,3,opt,name=groupByPathOff,proto3,oneof" json:"groupByPathOff,omitempty"`
	Offset         *int64 `protobuf:"varint,4,opt,name=offset,proto3,oneof" json:"offset,omitempty"`
	// limit specifies the maximum number of records in the result set
	Limit *int64 `protobuf:"varint,5,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) GetFilterConditions added in v0.94.0 

func (x *SearchRecordsRequest) GetFilterConditions() string

func (*SearchRecordsRequest) GetGroupByPathOff added in v0.94.0 

func (x *SearchRecordsRequest) GetGroupByPathOff() bool

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) GetTextQuery added in v0.94.0 

func (x *SearchRecordsRequest) GetTextQuery() 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"`
	Total int64                      `protobuf:"varint,2,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) 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 {
	Path            string   `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	Record          *Record  `protobuf:"bytes,2,opt,name=record,proto3" json:"record,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) GetMatchedKeywords added in v0.37.0 

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

func (*SearchRecordsResultItem) GetPath added in v0.80.0 

func (x *SearchRecordsResultItem) GetPath() string

func (*SearchRecordsResultItem) GetRecord added in v0.80.0 

func (x *SearchRecordsResultItem) GetRecord() *Record

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 the new records for a search.
	Create(ctx context.Context, in *CreateRecordsRequest, opts ...grpc.CallOption) (*CreateRecordsResult, error)
	// CreateWithStreamData allows to create new index records by streaming the records.
	CreateWithStreamData(ctx context.Context, opts ...grpc.CallOption) (Service_CreateWithStreamDataClient, error)
	// UpdateNode allows to update Node data, e.g. tags.
	UpdateNode(ctx context.Context, in *UpdateNodeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// DeleteNode allows to delete nodes according to the request provided
	DeleteNodes(ctx context.Context, in *DeleteNodesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// ListNodes returns all known children for the Path provided
	ListNodes(ctx context.Context, in *ListNodesRequest, opts ...grpc.CallOption) (*Nodes, error)
	// Patch 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 a path associated with it
	ListRecords(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListRecordsResult, error)
	// Search runs the search across all the index records matching the query. Result will
	// be ordered by the ranks for the request.
	Search(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 the new records for a search.
	Create(context.Context, *CreateRecordsRequest) (*CreateRecordsResult, error)
	// CreateWithStreamData allows to create new index records by streaming the records.
	CreateWithStreamData(Service_CreateWithStreamDataServer) error
	// UpdateNode allows to update Node data, e.g. tags.
	UpdateNode(context.Context, *UpdateNodeRequest) (*emptypb.Empty, error)
	// DeleteNode allows to delete nodes according to the request provided
	DeleteNodes(context.Context, *DeleteNodesRequest) (*emptypb.Empty, error)
	// ListNodes returns all known children for the Path provided
	ListNodes(context.Context, *ListNodesRequest) (*Nodes, error)
	// Patch allows to insert, update or delete an index's records
	PatchRecords(context.Context, *PatchRecordsRequest) (*PatchRecordsResult, error)
	// ListRecords returns list of records for a path associated with it
	ListRecords(context.Context, *ListRequest) (*ListRecordsResult, error)
	// Search runs the search across all the index records matching the query. Result will
	// be ordered by the ranks for the request.
	Search(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() (*CreateRecordsResult, error)
	grpc.ClientStream
}

type Service_CreateWithStreamDataServer added in v0.29.0 

type Service_CreateWithStreamDataServer interface {
	SendAndClose(*CreateRecordsResult) 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, *CreateRecordsRequest) (*CreateRecordsResult, error)

func (UnimplementedServiceServer) CreateWithStreamData added in v0.29.0 

func (UnimplementedServiceServer) CreateWithStreamData(Service_CreateWithStreamDataServer) error

func (UnimplementedServiceServer) DeleteNodes added in v0.98.0 

func (UnimplementedServiceServer) DeleteNodes(context.Context, *DeleteNodesRequest) (*emptypb.Empty, error)

func (UnimplementedServiceServer) ListNodes added in v0.80.0 

func (UnimplementedServiceServer) ListNodes(context.Context, *ListNodesRequest) (*Nodes, error)

func (UnimplementedServiceServer) ListRecords added in v0.6.0 

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

func (UnimplementedServiceServer) PatchRecords added in v0.6.0 

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

func (UnimplementedServiceServer) Search added in v0.80.0 

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

func (UnimplementedServiceServer) UpdateNode added in v0.80.0 

func (UnimplementedServiceServer) UpdateNode(context.Context, *UpdateNodeRequest) (*emptypb.Empty, 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.

type UpdateNodeRequest added in v0.80.0 

type UpdateNodeRequest struct {

	// path is the fqnp path to the node
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// node is the node data to be updated
	Node *Node `protobuf:"bytes,2,opt,name=node,proto3" json:"node,omitempty"`
	// contains filtered or unexported fields
}

UpdateNodeRequest describes input parameters for the node update operation

func (*UpdateNodeRequest) Descriptor deprecated added in v0.80.0 

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

Deprecated: Use UpdateNodeRequest.ProtoReflect.Descriptor instead.

func (*UpdateNodeRequest) GetNode added in v0.80.0 

func (x *UpdateNodeRequest) GetNode() *Node

func (*UpdateNodeRequest) GetPath added in v0.80.0 

func (x *UpdateNodeRequest) GetPath() string

func (*UpdateNodeRequest) ProtoMessage added in v0.80.0 

func (*UpdateNodeRequest) ProtoMessage()

func (*UpdateNodeRequest) ProtoReflect added in v0.80.0 

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

func (*UpdateNodeRequest) Reset added in v0.80.0 

func (x *UpdateNodeRequest) Reset()

func (*UpdateNodeRequest) String added in v0.80.0 

func (x *UpdateNodeRequest) String() string

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.