Documentation
¶
Overview ¶
Package serving_proto is a generated protocol buffer package.
It is generated from these files:
kythe/proto/serving.proto
It has these top-level messages:
Node EdgeSet PagedEdgeSet PageIndex EdgePage FileDirectory CorpusRoots FileDecorations PageToken
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CorpusRoots ¶
type CorpusRoots struct {
Corpus []*CorpusRoots_Corpus `protobuf:"bytes,1,rep,name=corpus" json:"corpus,omitempty"`
}
CorpusRoots describes all of the known corpus/root pairs that contain file nodes.
func (*CorpusRoots) GetCorpus ¶
func (m *CorpusRoots) GetCorpus() []*CorpusRoots_Corpus
func (*CorpusRoots) ProtoMessage ¶
func (*CorpusRoots) ProtoMessage()
func (*CorpusRoots) Reset ¶
func (m *CorpusRoots) Reset()
func (*CorpusRoots) String ¶
func (m *CorpusRoots) String() string
type CorpusRoots_Corpus ¶
type CorpusRoots_Corpus struct {
Corpus string `protobuf:"bytes,1,opt,name=corpus" json:"corpus,omitempty"`
Root []string `protobuf:"bytes,2,rep,name=root" json:"root,omitempty"`
}
func (*CorpusRoots_Corpus) ProtoMessage ¶
func (*CorpusRoots_Corpus) ProtoMessage()
func (*CorpusRoots_Corpus) Reset ¶
func (m *CorpusRoots_Corpus) Reset()
func (*CorpusRoots_Corpus) String ¶
func (m *CorpusRoots_Corpus) String() string
type EdgePage ¶
type EdgePage struct {
// Corresponding PageIndex key that can be used to lookup this page.
PageKey string `protobuf:"bytes,1,opt,name=page_key" json:"page_key,omitempty"`
SourceTicket string `protobuf:"bytes,2,opt,name=source_ticket" json:"source_ticket,omitempty"`
EdgesGroup *EdgeSet_Group `protobuf:"bytes,3,opt,name=edges_group" json:"edges_group,omitempty"`
}
EdgePages are a group of edges for a particular edge kind and source ticket.
func (*EdgePage) GetEdgesGroup ¶
func (m *EdgePage) GetEdgesGroup() *EdgeSet_Group
func (*EdgePage) ProtoMessage ¶
func (*EdgePage) ProtoMessage()
type EdgeSet ¶
type EdgeSet struct {
// The ticket of the source node for all the edges in the edge set.
SourceTicket string `protobuf:"bytes,1,opt,name=source_ticket" json:"source_ticket,omitempty"`
// Each group is a collection of outbound edges from source node sharing a
// given kind. In a given EdgeSet, the server will not send more than one
// group with the same kind label.
Group []*EdgeSet_Group `protobuf:"bytes,2,rep,name=group" json:"group,omitempty"`
}
An EdgeSet represents a collection of edges from a single node. The edges are organized into groups, each sharing a common edge kind.
The number of edges represented by an EdgeSet es, denoted len(es), is the sum of the lengths of the repeated target_ticket fields for all the groups in the EdgeSet. This count is used to determine page size in a request.
Note: this is a derivative of xref.EdgeSet
func (*EdgeSet) GetGroup ¶
func (m *EdgeSet) GetGroup() []*EdgeSet_Group
func (*EdgeSet) ProtoMessage ¶
func (*EdgeSet) ProtoMessage()
type EdgeSet_Group ¶
type EdgeSet_Group struct {
Kind string `protobuf:"bytes,1,opt,name=kind" json:"kind,omitempty"`
TargetTicket []string `protobuf:"bytes,2,rep,name=target_ticket" json:"target_ticket,omitempty"`
}
func (*EdgeSet_Group) ProtoMessage ¶
func (*EdgeSet_Group) ProtoMessage()
func (*EdgeSet_Group) Reset ¶
func (m *EdgeSet_Group) Reset()
func (*EdgeSet_Group) String ¶
func (m *EdgeSet_Group) String() string
type FileDecorations ¶
type FileDecorations struct {
FileTicket string `protobuf:"bytes,1,opt,name=file_ticket" json:"file_ticket,omitempty"`
SourceText []byte `protobuf:"bytes,2,opt,name=source_text,proto3" json:"source_text,omitempty"`
Encoding string `protobuf:"bytes,3,opt,name=encoding" json:"encoding,omitempty"`
// The decorations located in the file, sorted by starting offset.
Decoration []*FileDecorations_Decoration `protobuf:"bytes,4,rep,name=decoration" json:"decoration,omitempty"`
}
FileDecorations stores a file's contents and all contained anchor edges.
func (*FileDecorations) GetDecoration ¶
func (m *FileDecorations) GetDecoration() []*FileDecorations_Decoration
func (*FileDecorations) ProtoMessage ¶
func (*FileDecorations) ProtoMessage()
func (*FileDecorations) Reset ¶
func (m *FileDecorations) Reset()
func (*FileDecorations) String ¶
func (m *FileDecorations) String() string
type FileDecorations_Decoration ¶
type FileDecorations_Decoration struct {
Anchor *FileDecorations_Decoration_Anchor `protobuf:"bytes,1,opt,name=anchor" json:"anchor,omitempty"`
TargetTicket string `protobuf:"bytes,2,opt,name=target_ticket" json:"target_ticket,omitempty"`
Kind string `protobuf:"bytes,3,opt,name=kind" json:"kind,omitempty"`
}
Represents an edge from an anchor contained within the file to some target.
func (*FileDecorations_Decoration) GetAnchor ¶
func (m *FileDecorations_Decoration) GetAnchor() *FileDecorations_Decoration_Anchor
func (*FileDecorations_Decoration) ProtoMessage ¶
func (*FileDecorations_Decoration) ProtoMessage()
func (*FileDecorations_Decoration) Reset ¶
func (m *FileDecorations_Decoration) Reset()
func (*FileDecorations_Decoration) String ¶
func (m *FileDecorations_Decoration) String() string
type FileDecorations_Decoration_Anchor ¶
type FileDecorations_Decoration_Anchor struct {
Ticket string `protobuf:"bytes,1,opt,name=ticket" json:"ticket,omitempty"`
StartOffset int32 `protobuf:"varint,2,opt,name=start_offset" json:"start_offset,omitempty"`
EndOffset int32 `protobuf:"varint,3,opt,name=end_offset" json:"end_offset,omitempty"`
}
func (*FileDecorations_Decoration_Anchor) ProtoMessage ¶
func (*FileDecorations_Decoration_Anchor) ProtoMessage()
func (*FileDecorations_Decoration_Anchor) Reset ¶
func (m *FileDecorations_Decoration_Anchor) Reset()
func (*FileDecorations_Decoration_Anchor) String ¶
func (m *FileDecorations_Decoration_Anchor) String() string
type FileDirectory ¶
type FileDirectory struct {
// Set of URIs for each contained sub-directory's corpus, root, and full path.
Subdirectory []string `protobuf:"bytes,1,rep,name=subdirectory" json:"subdirectory,omitempty"`
// Set of file node tickets contained within this directory.
FileTicket []string `protobuf:"bytes,2,rep,name=file_ticket" json:"file_ticket,omitempty"`
}
FileDirectory describes a virtual directory of file nodes.
func (*FileDirectory) ProtoMessage ¶
func (*FileDirectory) ProtoMessage()
func (*FileDirectory) Reset ¶
func (m *FileDirectory) Reset()
func (*FileDirectory) String ¶
func (m *FileDirectory) String() string
type Node ¶
type Node struct {
Ticket string `protobuf:"bytes,1,opt,name=ticket" json:"ticket,omitempty"`
Fact []*Node_Fact `protobuf:"bytes,2,rep,name=fact" json:"fact,omitempty"`
}
A derivative of xref.NodeInfo for serving.
func (*Node) ProtoMessage ¶
func (*Node) ProtoMessage()
type Node_Fact ¶
type Node_Fact struct {
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
}
func (*Node_Fact) ProtoMessage ¶
func (*Node_Fact) ProtoMessage()
type PageIndex ¶
type PageIndex struct {
// The kind of all edges on the referred EdgePage.
EdgeKind string `protobuf:"bytes,1,opt,name=edge_kind" json:"edge_kind,omitempty"`
// Total number of edges on the referred EdgePage.
EdgeCount int32 `protobuf:"varint,2,opt,name=edge_count" json:"edge_count,omitempty"`
// Key that can be used to lookup the referred EdgePage.
PageKey string `protobuf:"bytes,3,opt,name=page_key" json:"page_key,omitempty"`
}
PageIndex is a pointer to an EdgePage. In order to keep the PagedEdgeSet small, we don't store edges here. We just store a key for looking up an EdgePage and the type of edge.
func (*PageIndex) ProtoMessage ¶
func (*PageIndex) ProtoMessage()
type PageToken ¶
type PageToken struct {
// Index into sequence of edges to return in EdgesReply.
Index int32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
}
Internal encoding for an EdgesReply page_token
func (*PageToken) ProtoMessage ¶
func (*PageToken) ProtoMessage()
type PagedEdgeSet ¶
type PagedEdgeSet struct {
// Collection of edges on the first page. If the number of edges for a
// particular source_ticket is small, this may contain all known edges and
// no page_index will exist.
EdgeSet *EdgeSet `protobuf:"bytes,1,opt,name=edge_set" json:"edge_set,omitempty"`
// Total number of edges in all of the EdgePages, including this one.
TotalEdges int32 `protobuf:"varint,2,opt,name=total_edges" json:"total_edges,omitempty"`
// Page indices for other EdgePages, sorted by edge kind.
PageIndex []*PageIndex `protobuf:"bytes,3,rep,name=page_index" json:"page_index,omitempty"`
}
PagedEdgeSets are used for efficiently storing EdgeSets, all originating from the same source ticket, in order to handle pagination requests.
func (*PagedEdgeSet) GetEdgeSet ¶
func (m *PagedEdgeSet) GetEdgeSet() *EdgeSet
func (*PagedEdgeSet) GetPageIndex ¶
func (m *PagedEdgeSet) GetPageIndex() []*PageIndex
func (*PagedEdgeSet) ProtoMessage ¶
func (*PagedEdgeSet) ProtoMessage()
func (*PagedEdgeSet) Reset ¶
func (m *PagedEdgeSet) Reset()
func (*PagedEdgeSet) String ¶
func (m *PagedEdgeSet) String() string
Source Files
Click to show internal directories.
Click to hide internal directories.