serving_proto

package
v0.0.16 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2015 License: Apache-2.0 Imports: 3 Imported by: 0

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: 

Fact
Node
Edge
EdgeSet
PagedEdgeSet
PageIndex
EdgePage
FileDirectory
CorpusRoots
File
Anchor
FileDecorations
CrossReference
PageToken

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Anchor added in v0.0.16 

type 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"`
}

An Anchor is a specialized Node structure for anchor nodes.

func (*Anchor) ProtoMessage added in v0.0.16 

func (*Anchor) ProtoMessage()

func (*Anchor) Reset added in v0.0.16 

func (m *Anchor) Reset()

func (*Anchor) String added in v0.0.16 

func (m *Anchor) String() string

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 CrossReference added in v0.0.16 

type CrossReference struct {
	SourceDecoration *CrossReference_Decoration `protobuf:"bytes,1,opt,name=source_decoration" json:"source_decoration,omitempty"`
	Referent         *Node                      `protobuf:"bytes,2,opt,name=referent" json:"referent,omitempty"`
	TargetDecoration *CrossReference_Decoration `protobuf:"bytes,3,opt,name=target_decoration" json:"target_decoration,omitempty"`
}

A CrossReference represents a path between two anchors, crossing between a single common node. Abstractly this a (file, anchor, kind, node, kind', anchor', file') tuple where the two (file, anchor, kind) sub-components have been named Decorations.

This structure can be used to represent the intermediary* structures needed to build pre-cached responses to the Decorations and CrossReferences service methods.

* where only a subset of this structure is known at that moment in time

func (*CrossReference) GetReferent added in v0.0.16 

func (m *CrossReference) GetReferent() *Node

func (*CrossReference) GetSourceDecoration added in v0.0.16 

func (m *CrossReference) GetSourceDecoration() *CrossReference_Decoration

func (*CrossReference) GetTargetDecoration added in v0.0.16 

func (m *CrossReference) GetTargetDecoration() *CrossReference_Decoration

func (*CrossReference) ProtoMessage added in v0.0.16 

func (*CrossReference) ProtoMessage()

func (*CrossReference) Reset added in v0.0.16 

func (m *CrossReference) Reset()

func (*CrossReference) String added in v0.0.16 

func (m *CrossReference) String() string

type CrossReference_Decoration added in v0.0.16 

type CrossReference_Decoration struct {
	File   *File   `protobuf:"bytes,1,opt,name=file" json:"file,omitempty"`
	Anchor *Anchor `protobuf:"bytes,2,opt,name=anchor" json:"anchor,omitempty"`
	Kind   string  `protobuf:"bytes,3,opt,name=kind" json:"kind,omitempty"`
}

A Decoration is specialized partial edge with an anchor on one end, stored along side its parent file node. The partial edge's other end is stored in the referent field of the parent CrossReference.

func (*CrossReference_Decoration) GetAnchor added in v0.0.16 

func (m *CrossReference_Decoration) GetAnchor() *Anchor

func (*CrossReference_Decoration) GetFile added in v0.0.16 

func (m *CrossReference_Decoration) GetFile() *File

func (*CrossReference_Decoration) ProtoMessage added in v0.0.16 

func (*CrossReference_Decoration) ProtoMessage()

func (*CrossReference_Decoration) Reset added in v0.0.16 

func (m *CrossReference_Decoration) Reset()

func (*CrossReference_Decoration) String added in v0.0.16 

func (m *CrossReference_Decoration) String() string

type Edge added in v0.0.16 

type Edge struct {
	Source *Node   `protobuf:"bytes,1,opt,name=source" json:"source,omitempty"`
	Kind   string  `protobuf:"bytes,2,opt,name=kind" json:"kind,omitempty"`
	Target *Node   `protobuf:"bytes,3,opt,name=target" json:"target,omitempty"`
	Fact   []*Fact `protobuf:"bytes,4,rep,name=fact" json:"fact,omitempty"`
}

Full representation of a Kythe edge; useful during post-processing.

func (*Edge) GetFact added in v0.0.16 

func (m *Edge) GetFact() []*Fact

func (*Edge) GetSource added in v0.0.16 

func (m *Edge) GetSource() *Node

func (*Edge) GetTarget added in v0.0.16 

func (m *Edge) GetTarget() *Node

func (*Edge) ProtoMessage added in v0.0.16 

func (*Edge) ProtoMessage()

func (*Edge) Reset added in v0.0.16 

func (m *Edge) Reset()

func (*Edge) String added in v0.0.16 

func (m *Edge) 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()

func (*EdgePage) Reset 

func (m *EdgePage) Reset()

func (*EdgePage) String 

func (m *EdgePage) String() string

type EdgeSet 

type EdgeSet struct {
	// The source node for all the edges in the edge set.
	Source *Node `protobuf:"bytes,1,opt,name=source" json:"source,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) GetSource added in v0.0.16 

func (m *EdgeSet) GetSource() *Node

func (*EdgeSet) ProtoMessage 

func (*EdgeSet) ProtoMessage()

func (*EdgeSet) Reset 

func (m *EdgeSet) Reset()

func (*EdgeSet) String 

func (m *EdgeSet) String() string

type EdgeSet_Group 

type EdgeSet_Group struct {
	Kind   string  `protobuf:"bytes,1,opt,name=kind" json:"kind,omitempty"`
	Target []*Node `protobuf:"bytes,2,rep,name=target" json:"target,omitempty"`
}

func (*EdgeSet_Group) GetTarget added in v0.0.16 

func (m *EdgeSet_Group) GetTarget() []*Node

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 Fact added in v0.0.16 

type 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"`
}

Kythe fact (i.e. from a storage.Entry). Can belong to either a Node or Edge.

func (*Fact) ProtoMessage added in v0.0.16 

func (*Fact) ProtoMessage()

func (*Fact) Reset added in v0.0.16 

func (m *Fact) Reset()

func (*Fact) String added in v0.0.16 

func (m *Fact) String() string

type File added in v0.0.16 

type File struct {
	Ticket   string `protobuf:"bytes,1,opt,name=ticket" json:"ticket,omitempty"`
	Text     []byte `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	Encoding string `protobuf:"bytes,3,opt,name=encoding" json:"encoding,omitempty"`
}

A File is a specialized Node structure for file nodes.

func (*File) ProtoMessage added in v0.0.16 

func (*File) ProtoMessage()

func (*File) Reset added in v0.0.16 

func (m *File) Reset()

func (*File) String added in v0.0.16 

func (m *File) String() string

type FileDecorations 

type FileDecorations struct {
	File *File `protobuf:"bytes,1,opt,name=file" json:"file,omitempty"`
	// The decorations located in the file, sorted by starting offset.
	Decoration []*FileDecorations_Decoration `protobuf:"bytes,2,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) GetFile added in v0.0.16 

func (m *FileDecorations) GetFile() *File

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 *Anchor `protobuf:"bytes,1,opt,name=anchor" json:"anchor,omitempty"`
	Kind   string  `protobuf:"bytes,2,opt,name=kind" json:"kind,omitempty"`
	Target *Node   `protobuf:"bytes,3,opt,name=target" json:"target,omitempty"`
}

Represents an edge from an anchor contained within the file to some target.

func (*FileDecorations_Decoration) GetAnchor 

func (m *FileDecorations_Decoration) GetAnchor() *Anchor

func (*FileDecorations_Decoration) GetTarget added in v0.0.16 

func (m *FileDecorations_Decoration) GetTarget() *Node

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 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   []*Fact `protobuf:"bytes,2,rep,name=fact" json:"fact,omitempty"`
}

A derivative of xref.NodeInfo for serving.

func (*Node) GetFact 

func (m *Node) GetFact() []*Fact

func (*Node) ProtoMessage 

func (*Node) ProtoMessage()

func (*Node) Reset 

func (m *Node) Reset()

func (*Node) String 

func (m *Node) String() string

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()

func (*PageIndex) Reset 

func (m *PageIndex) Reset()

func (*PageIndex) String 

func (m *PageIndex) String() string

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()

func (*PageToken) Reset 

func (m *PageToken) Reset()

func (*PageToken) String 

func (m *PageToken) String() string

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

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.