Documentation
¶
Index ¶
- Variables
- type AnalysisOutput
- func (*AnalysisOutput) Descriptor() ([]byte, []int)deprecated
- func (x *AnalysisOutput) GetFinalResult() *AnalysisResult
- func (x *AnalysisOutput) GetValue() []byte
- func (*AnalysisOutput) ProtoMessage()
- func (x *AnalysisOutput) ProtoReflect() protoreflect.Message
- func (x *AnalysisOutput) Reset()
- func (x *AnalysisOutput) String() string
- type AnalysisRequest
- func (*AnalysisRequest) Descriptor() ([]byte, []int)deprecated
- func (x *AnalysisRequest) GetBuildId() string
- func (x *AnalysisRequest) GetCompilation() *CompilationUnit
- func (x *AnalysisRequest) GetFileDataService() string
- func (x *AnalysisRequest) GetRevision() string
- func (*AnalysisRequest) ProtoMessage()
- func (x *AnalysisRequest) ProtoReflect() protoreflect.Message
- func (x *AnalysisRequest) Reset()
- func (x *AnalysisRequest) String() string
- type AnalysisResult
- func (*AnalysisResult) Descriptor() ([]byte, []int)deprecated
- func (x *AnalysisResult) GetDetails() []*anypb.Any
- func (x *AnalysisResult) GetStatus() AnalysisResult_Status
- func (x *AnalysisResult) GetSummary() string
- func (*AnalysisResult) ProtoMessage()
- func (x *AnalysisResult) ProtoReflect() protoreflect.Message
- func (x *AnalysisResult) Reset()
- func (x *AnalysisResult) String() string
- type AnalysisResult_Status
- func (AnalysisResult_Status) Descriptor() protoreflect.EnumDescriptor
- func (x AnalysisResult_Status) Enum() *AnalysisResult_Status
- func (AnalysisResult_Status) EnumDescriptor() ([]byte, []int)deprecated
- func (x AnalysisResult_Status) Number() protoreflect.EnumNumber
- func (x AnalysisResult_Status) String() string
- func (AnalysisResult_Status) Type() protoreflect.EnumType
- type BuildDetails
- func (*BuildDetails) Descriptor() ([]byte, []int)deprecated
- func (x *BuildDetails) GetBuildConfig() string
- func (x *BuildDetails) GetBuildTarget() string
- func (x *BuildDetails) GetRuleType() string
- func (*BuildDetails) ProtoMessage()
- func (x *BuildDetails) ProtoReflect() protoreflect.Message
- func (x *BuildDetails) Reset()
- func (x *BuildDetails) String() string
- type BuildMetadata
- type CompilationBundle
- func (*CompilationBundle) Descriptor() ([]byte, []int)deprecated
- func (x *CompilationBundle) GetFiles() []*FileData
- func (x *CompilationBundle) GetUnit() *CompilationUnit
- func (*CompilationBundle) ProtoMessage()
- func (x *CompilationBundle) ProtoReflect() protoreflect.Message
- func (x *CompilationBundle) Reset()
- func (x *CompilationBundle) String() string
- type CompilationUnit
- func (*CompilationUnit) Descriptor() ([]byte, []int)deprecated
- func (x *CompilationUnit) GetArgument() []string
- func (x *CompilationUnit) GetDetails() []*anypb.Any
- func (x *CompilationUnit) GetEntryContext() string
- func (x *CompilationUnit) GetEnvironment() []*CompilationUnit_Env
- func (x *CompilationUnit) GetHasCompileErrors() bool
- func (x *CompilationUnit) GetOutputKey() string
- func (x *CompilationUnit) GetRequiredInput() []*CompilationUnit_FileInput
- func (x *CompilationUnit) GetSourceFile() []string
- func (x *CompilationUnit) GetVName() *VName
- func (x *CompilationUnit) GetWorkingDirectory() string
- func (*CompilationUnit) ProtoMessage()
- func (x *CompilationUnit) ProtoReflect() protoreflect.Message
- func (x *CompilationUnit) Reset()
- func (x *CompilationUnit) String() string
- type CompilationUnit_Env
- func (*CompilationUnit_Env) Descriptor() ([]byte, []int)deprecated
- func (x *CompilationUnit_Env) GetName() string
- func (x *CompilationUnit_Env) GetValue() string
- func (*CompilationUnit_Env) ProtoMessage()
- func (x *CompilationUnit_Env) ProtoReflect() protoreflect.Message
- func (x *CompilationUnit_Env) Reset()
- func (x *CompilationUnit_Env) String() string
- type CompilationUnit_FileInput
- func (*CompilationUnit_FileInput) Descriptor() ([]byte, []int)deprecated
- func (x *CompilationUnit_FileInput) GetDetails() []*anypb.Any
- func (x *CompilationUnit_FileInput) GetInfo() *FileInfo
- func (x *CompilationUnit_FileInput) GetVName() *VName
- func (*CompilationUnit_FileInput) ProtoMessage()
- func (x *CompilationUnit_FileInput) ProtoReflect() protoreflect.Message
- func (x *CompilationUnit_FileInput) Reset()
- func (x *CompilationUnit_FileInput) String() string
- type CountReply
- type CountRequest
- func (*CountRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CountRequest) GetIndex() int64
- func (x *CountRequest) GetShards() int64
- func (*CountRequest) ProtoMessage()
- func (x *CountRequest) ProtoReflect() protoreflect.Message
- func (x *CountRequest) Reset()
- func (x *CountRequest) String() string
- type Entries
- type Entry
- func (*Entry) Descriptor() ([]byte, []int)deprecated
- func (x *Entry) GetEdgeKind() string
- func (x *Entry) GetFactName() string
- func (x *Entry) GetFactValue() []byte
- func (x *Entry) GetSource() *VName
- func (x *Entry) GetTarget() *VName
- func (*Entry) ProtoMessage()
- func (x *Entry) ProtoReflect() protoreflect.Message
- func (x *Entry) Reset()
- func (x *Entry) String() string
- type FileData
- func (*FileData) Descriptor() ([]byte, []int)deprecated
- func (x *FileData) GetContent() []byte
- func (x *FileData) GetInfo() *FileInfo
- func (x *FileData) GetMissing() bool
- func (*FileData) ProtoMessage()
- func (x *FileData) ProtoReflect() protoreflect.Message
- func (x *FileData) Reset()
- func (x *FileData) String() string
- type FileInfo
- type FilesRequest
- type IndexedCompilation
- func (*IndexedCompilation) Descriptor() ([]byte, []int)deprecated
- func (x *IndexedCompilation) GetIndex() *IndexedCompilation_Index
- func (x *IndexedCompilation) GetUnit() *CompilationUnit
- func (*IndexedCompilation) ProtoMessage()
- func (x *IndexedCompilation) ProtoReflect() protoreflect.Message
- func (x *IndexedCompilation) Reset()
- func (x *IndexedCompilation) String() string
- type IndexedCompilation_Index
- func (*IndexedCompilation_Index) Descriptor() ([]byte, []int)deprecated
- func (x *IndexedCompilation_Index) GetRevisions() []string
- func (*IndexedCompilation_Index) ProtoMessage()
- func (x *IndexedCompilation_Index) ProtoReflect() protoreflect.Message
- func (x *IndexedCompilation_Index) Reset()
- func (x *IndexedCompilation_Index) String() string
- type JarDetails
- type JarDetails_Jar
- type JarEntryDetails
- type JavaDetails
- func (*JavaDetails) Descriptor() ([]byte, []int)deprecated
- func (x *JavaDetails) GetBootclasspath() []string
- func (x *JavaDetails) GetClasspath() []string
- func (x *JavaDetails) GetExtraJavacopts() []string
- func (x *JavaDetails) GetSourcepath() []string
- func (*JavaDetails) ProtoMessage()
- func (x *JavaDetails) ProtoReflect() protoreflect.Message
- func (x *JavaDetails) Reset()
- func (x *JavaDetails) String() string
- type KzipInfo
- func (*KzipInfo) Descriptor() ([]byte, []int)deprecated
- func (x *KzipInfo) GetAbsolutePaths() []string
- func (x *KzipInfo) GetCorpora() map[string]*KzipInfo_CorpusInfo
- func (x *KzipInfo) GetCriticalKzipErrors() []string
- func (x *KzipInfo) GetSize() int64
- func (*KzipInfo) ProtoMessage()
- func (x *KzipInfo) ProtoReflect() protoreflect.Message
- func (x *KzipInfo) Reset()
- func (x *KzipInfo) String() string
- type KzipInfo_CorpusInfo
- func (*KzipInfo_CorpusInfo) Descriptor() ([]byte, []int)deprecated
- func (x *KzipInfo_CorpusInfo) GetLanguageRequiredInputs() map[string]*KzipInfo_CorpusInfo_RequiredInputs
- func (x *KzipInfo_CorpusInfo) GetLanguageSources() map[string]*KzipInfo_CorpusInfo_RequiredInputs
- func (*KzipInfo_CorpusInfo) ProtoMessage()
- func (x *KzipInfo_CorpusInfo) ProtoReflect() protoreflect.Message
- func (x *KzipInfo_CorpusInfo) Reset()
- func (x *KzipInfo_CorpusInfo) String() string
- type KzipInfo_CorpusInfo_RequiredInputs
- func (*KzipInfo_CorpusInfo_RequiredInputs) Descriptor() ([]byte, []int)deprecated
- func (x *KzipInfo_CorpusInfo_RequiredInputs) GetCount() int32
- func (*KzipInfo_CorpusInfo_RequiredInputs) ProtoMessage()
- func (x *KzipInfo_CorpusInfo_RequiredInputs) ProtoReflect() protoreflect.Message
- func (x *KzipInfo_CorpusInfo_RequiredInputs) Reset()
- func (x *KzipInfo_CorpusInfo_RequiredInputs) String() string
- type ReadRequest
- func (*ReadRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ReadRequest) GetEdgeKind() string
- func (x *ReadRequest) GetSource() *VName
- func (*ReadRequest) ProtoMessage()
- func (x *ReadRequest) ProtoReflect() protoreflect.Message
- func (x *ReadRequest) Reset()
- func (x *ReadRequest) String() string
- type ScanRequest
- func (*ScanRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ScanRequest) GetEdgeKind() string
- func (x *ScanRequest) GetFactPrefix() string
- func (x *ScanRequest) GetTarget() *VName
- func (*ScanRequest) ProtoMessage()
- func (x *ScanRequest) ProtoReflect() protoreflect.Message
- func (x *ScanRequest) Reset()
- func (x *ScanRequest) String() string
- type ShardRequest
- func (*ShardRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ShardRequest) GetIndex() int64
- func (x *ShardRequest) GetShards() int64
- func (*ShardRequest) ProtoMessage()
- func (x *ShardRequest) ProtoReflect() protoreflect.Message
- func (x *ShardRequest) Reset()
- func (x *ShardRequest) String() string
- type VName
- func (*VName) Descriptor() ([]byte, []int)deprecated
- func (x *VName) GetCorpus() string
- func (x *VName) GetLanguage() string
- func (x *VName) GetPath() string
- func (x *VName) GetRoot() string
- func (x *VName) GetSignature() string
- func (*VName) ProtoMessage()
- func (x *VName) ProtoReflect() protoreflect.Message
- func (x *VName) Reset()
- func (x *VName) String() string
- type VNameMask
- func (*VNameMask) Descriptor() ([]byte, []int)deprecated
- func (x *VNameMask) GetCorpus() bool
- func (x *VNameMask) GetLanguage() bool
- func (x *VNameMask) GetPath() bool
- func (x *VNameMask) GetRoot() bool
- func (x *VNameMask) GetSignature() bool
- func (*VNameMask) ProtoMessage()
- func (x *VNameMask) ProtoReflect() protoreflect.Message
- func (x *VNameMask) Reset()
- func (x *VNameMask) String() string
- type VNameRewriteRule
- func (*VNameRewriteRule) Descriptor() ([]byte, []int)deprecated
- func (x *VNameRewriteRule) GetPattern() string
- func (x *VNameRewriteRule) GetVName() *VName
- func (*VNameRewriteRule) ProtoMessage()
- func (x *VNameRewriteRule) ProtoReflect() protoreflect.Message
- func (x *VNameRewriteRule) Reset()
- func (x *VNameRewriteRule) String() string
- type VNameRewriteRules
- func (*VNameRewriteRules) Descriptor() ([]byte, []int)deprecated
- func (x *VNameRewriteRules) GetRule() []*VNameRewriteRule
- func (*VNameRewriteRules) ProtoMessage()
- func (x *VNameRewriteRules) ProtoReflect() protoreflect.Message
- func (x *VNameRewriteRules) Reset()
- func (x *VNameRewriteRules) String() string
- type WriteReply
- type WriteRequest
- func (*WriteRequest) Descriptor() ([]byte, []int)deprecated
- func (x *WriteRequest) GetSource() *VName
- func (x *WriteRequest) GetUpdate() []*WriteRequest_Update
- func (*WriteRequest) ProtoMessage()
- func (x *WriteRequest) ProtoReflect() protoreflect.Message
- func (x *WriteRequest) Reset()
- func (x *WriteRequest) String() string
- type WriteRequest_Update
- func (*WriteRequest_Update) Descriptor() ([]byte, []int)deprecated
- func (x *WriteRequest_Update) GetEdgeKind() string
- func (x *WriteRequest_Update) GetFactName() string
- func (x *WriteRequest_Update) GetFactValue() []byte
- func (x *WriteRequest_Update) GetTarget() *VName
- func (*WriteRequest_Update) ProtoMessage()
- func (x *WriteRequest_Update) ProtoReflect() protoreflect.Message
- func (x *WriteRequest_Update) Reset()
- func (x *WriteRequest_Update) String() string
Constants ¶
This section is empty.
Variables ¶
var ( AnalysisResult_Status_name = map[int32]string{ 0: "COMPLETE", 1: "INCOMPLETE", 2: "INVALID_REQUEST", } AnalysisResult_Status_value = map[string]int32{ "COMPLETE": 0, "INCOMPLETE": 1, "INVALID_REQUEST": 2, } )
Enum value maps for AnalysisResult_Status.
var File_kythe_proto_analysis_proto protoreflect.FileDescriptor
var File_kythe_proto_buildinfo_proto protoreflect.FileDescriptor
var File_kythe_proto_java_proto protoreflect.FileDescriptor
var File_kythe_proto_storage_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AnalysisOutput ¶
type AnalysisOutput struct { // The format of `value` is determined by the analyzer. Kythe language // indexers emit wire-format kythe.proto.Entry messages. Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // An analyzer may optionally report the final result of analysis by // populating this field in the last output it emits. // // Constraints: If final_result is set, value must be unset, and once a // final_result has been sent no further outputs may be sent. The driver must // enforce these constraints by aborting and discarding the request if the // analyzer sends additional data after the final_result. It is legal for the // analyzer to omit any final_result, in which case the driver will assume // that the analysis was completed successfully. FinalResult *AnalysisResult `protobuf:"bytes,10,opt,name=final_result,json=finalResult,proto3" json:"final_result,omitempty"` // contains filtered or unexported fields }
AnalysisOutput contains an output artifact for the current analysis taking place. A given analysis may not produce any outputs. It is okay for an indexer to send an empty AnalysisOutput message if needed to keep the RPC channel alive; the driver must correctly handle this.
func (*AnalysisOutput) Descriptor
deprecated
func (*AnalysisOutput) Descriptor() ([]byte, []int)
Deprecated: Use AnalysisOutput.ProtoReflect.Descriptor instead.
func (*AnalysisOutput) GetFinalResult ¶
func (x *AnalysisOutput) GetFinalResult() *AnalysisResult
func (*AnalysisOutput) GetValue ¶
func (x *AnalysisOutput) GetValue() []byte
func (*AnalysisOutput) ProtoMessage ¶
func (*AnalysisOutput) ProtoMessage()
func (*AnalysisOutput) ProtoReflect ¶
func (x *AnalysisOutput) ProtoReflect() protoreflect.Message
func (*AnalysisOutput) Reset ¶
func (x *AnalysisOutput) Reset()
func (*AnalysisOutput) String ¶
func (x *AnalysisOutput) String() string
type AnalysisRequest ¶
type AnalysisRequest struct { // The compilation to analyze. Compilation *CompilationUnit `protobuf:"bytes,1,opt,name=compilation,proto3" json:"compilation,omitempty"` // The address of a file data service to use. If this is provided, it should // be used in preference to any other file data service the analyzer may know // about for this compilation. FileDataService string `protobuf:"bytes,2,opt,name=file_data_service,json=fileDataService,proto3" json:"file_data_service,omitempty"` // The revision marker that should be attributed to this compilation. Revision string `protobuf:"bytes,3,opt,name=revision,proto3" json:"revision,omitempty"` // An identifier for the current analysis. BuildId string `protobuf:"bytes,4,opt,name=build_id,json=buildId,proto3" json:"build_id,omitempty"` // contains filtered or unexported fields }
An AnalysisRequest instructs an analyzer to perform an analysis on a single CompilationUnit.
func (*AnalysisRequest) Descriptor
deprecated
func (*AnalysisRequest) Descriptor() ([]byte, []int)
Deprecated: Use AnalysisRequest.ProtoReflect.Descriptor instead.
func (*AnalysisRequest) GetBuildId ¶
func (x *AnalysisRequest) GetBuildId() string
func (*AnalysisRequest) GetCompilation ¶
func (x *AnalysisRequest) GetCompilation() *CompilationUnit
func (*AnalysisRequest) GetFileDataService ¶
func (x *AnalysisRequest) GetFileDataService() string
func (*AnalysisRequest) GetRevision ¶
func (x *AnalysisRequest) GetRevision() string
func (*AnalysisRequest) ProtoMessage ¶
func (*AnalysisRequest) ProtoMessage()
func (*AnalysisRequest) ProtoReflect ¶
func (x *AnalysisRequest) ProtoReflect() protoreflect.Message
func (*AnalysisRequest) Reset ¶
func (x *AnalysisRequest) Reset()
func (*AnalysisRequest) String ¶
func (x *AnalysisRequest) String() string
type AnalysisResult ¶
type AnalysisResult struct { Status AnalysisResult_Status `protobuf:"varint,1,opt,name=status,proto3,enum=kythe.proto.AnalysisResult_Status" json:"status,omitempty"` // the status code describing the result Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"` // a human-readable error message for use in diagnostics // Freeform details from the analyzer Details []*anypb.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
AnalysisResult documents the analyzer's opinion of an analysis request.
func (*AnalysisResult) Descriptor
deprecated
func (*AnalysisResult) Descriptor() ([]byte, []int)
Deprecated: Use AnalysisResult.ProtoReflect.Descriptor instead.
func (*AnalysisResult) GetDetails ¶
func (x *AnalysisResult) GetDetails() []*anypb.Any
func (*AnalysisResult) GetStatus ¶
func (x *AnalysisResult) GetStatus() AnalysisResult_Status
func (*AnalysisResult) GetSummary ¶
func (x *AnalysisResult) GetSummary() string
func (*AnalysisResult) ProtoMessage ¶
func (*AnalysisResult) ProtoMessage()
func (*AnalysisResult) ProtoReflect ¶
func (x *AnalysisResult) ProtoReflect() protoreflect.Message
func (*AnalysisResult) Reset ¶
func (x *AnalysisResult) Reset()
func (*AnalysisResult) String ¶
func (x *AnalysisResult) String() string
type AnalysisResult_Status ¶
type AnalysisResult_Status int32
const ( AnalysisResult_COMPLETE AnalysisResult_Status = 0 // analysis completed successfully without error AnalysisResult_INCOMPLETE AnalysisResult_Status = 1 // analysis ended after partial results AnalysisResult_INVALID_REQUEST AnalysisResult_Status = 2 // the analysis request was invalid for this analyzer )
func (AnalysisResult_Status) Descriptor ¶
func (AnalysisResult_Status) Descriptor() protoreflect.EnumDescriptor
func (AnalysisResult_Status) Enum ¶
func (x AnalysisResult_Status) Enum() *AnalysisResult_Status
func (AnalysisResult_Status) EnumDescriptor
deprecated
func (AnalysisResult_Status) EnumDescriptor() ([]byte, []int)
Deprecated: Use AnalysisResult_Status.Descriptor instead.
func (AnalysisResult_Status) Number ¶
func (x AnalysisResult_Status) Number() protoreflect.EnumNumber
func (AnalysisResult_Status) String ¶
func (x AnalysisResult_Status) String() string
func (AnalysisResult_Status) Type ¶
func (AnalysisResult_Status) Type() protoreflect.EnumType
type BuildDetails ¶
type BuildDetails struct { // For build tools such as Bazel, that assign names to buildable targets, the // name of the build target that generated this compilation. BuildTarget string `protobuf:"bytes,1,opt,name=build_target,json=buildTarget,proto3" json:"build_target,omitempty"` // If known, the name or mnemonic of the generating rule. RuleType string `protobuf:"bytes,2,opt,name=rule_type,json=ruleType,proto3" json:"rule_type,omitempty"` // A pithy, user-meaningful description of the configuration or platform // this compilation is targeting, e.g. "android", "linux", // "mips-dec-ultrix4.2", etc. BuildConfig string `protobuf:"bytes,3,opt,name=build_config,json=buildConfig,proto3" json:"build_config,omitempty"` // contains filtered or unexported fields }
Details from the build tool used in a CompilationUnit. Its type is "kythe.io/proto/kythe.proto.BuildDetails".
func (*BuildDetails) Descriptor
deprecated
func (*BuildDetails) Descriptor() ([]byte, []int)
Deprecated: Use BuildDetails.ProtoReflect.Descriptor instead.
func (*BuildDetails) GetBuildConfig ¶
func (x *BuildDetails) GetBuildConfig() string
func (*BuildDetails) GetBuildTarget ¶
func (x *BuildDetails) GetBuildTarget() string
func (*BuildDetails) GetRuleType ¶
func (x *BuildDetails) GetRuleType() string
func (*BuildDetails) ProtoMessage ¶
func (*BuildDetails) ProtoMessage()
func (*BuildDetails) ProtoReflect ¶
func (x *BuildDetails) ProtoReflect() protoreflect.Message
func (*BuildDetails) Reset ¶
func (x *BuildDetails) Reset()
func (*BuildDetails) String ¶
func (x *BuildDetails) String() string
type BuildMetadata ¶
type BuildMetadata struct { // The commit_timestamp is generally the timestamp at which the source for // this build was checked into version control, but can be any timestamp // associated with the origin of this build. In the case that a project is // made up of multiple repositories, this timestamp should be the one // associated with the primary/super repository. CommitTimestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=commit_timestamp,json=commitTimestamp,proto3" json:"commit_timestamp,omitempty"` // contains filtered or unexported fields }
RepoMetadata provides storage for additional information about a specific build from a repository. This message is stored in the CompilationUnit.details field.
func (*BuildMetadata) Descriptor
deprecated
func (*BuildMetadata) Descriptor() ([]byte, []int)
Deprecated: Use BuildMetadata.ProtoReflect.Descriptor instead.
func (*BuildMetadata) GetCommitTimestamp ¶
func (x *BuildMetadata) GetCommitTimestamp() *timestamppb.Timestamp
func (*BuildMetadata) ProtoMessage ¶
func (*BuildMetadata) ProtoMessage()
func (*BuildMetadata) ProtoReflect ¶
func (x *BuildMetadata) ProtoReflect() protoreflect.Message
func (*BuildMetadata) Reset ¶
func (x *BuildMetadata) Reset()
func (*BuildMetadata) String ¶
func (x *BuildMetadata) String() string
type CompilationBundle ¶
type CompilationBundle struct { // The CompilationUnit to be analyzed. Unit *CompilationUnit `protobuf:"bytes,1,opt,name=unit,proto3" json:"unit,omitempty"` // File data for the CompilationUnit's required_input. Files []*FileData `protobuf:"bytes,2,rep,name=files,proto3" json:"files,omitempty"` // contains filtered or unexported fields }
A CompilationBundle carries a CompilationUnit and its required FileData.
func (*CompilationBundle) Descriptor
deprecated
func (*CompilationBundle) Descriptor() ([]byte, []int)
Deprecated: Use CompilationBundle.ProtoReflect.Descriptor instead.
func (*CompilationBundle) GetFiles ¶
func (x *CompilationBundle) GetFiles() []*FileData
func (*CompilationBundle) GetUnit ¶
func (x *CompilationBundle) GetUnit() *CompilationUnit
func (*CompilationBundle) ProtoMessage ¶
func (*CompilationBundle) ProtoMessage()
func (*CompilationBundle) ProtoReflect ¶
func (x *CompilationBundle) ProtoReflect() protoreflect.Message
func (*CompilationBundle) Reset ¶
func (x *CompilationBundle) Reset()
func (*CompilationBundle) String ¶
func (x *CompilationBundle) String() string
type CompilationUnit ¶
type CompilationUnit struct { // The base VName for the compilation and any VNames generated from its // analysis. The `v_name` field does not identify a compilation unit, but // provides the information the analyzer needs to correctly label the // entities described by its source. At minimum, this should include the // `corpus` and `language` the unit belongs to, and if appropriate the // `root`. The `v_name` of an object in the code is formed by merging its // specifics into this basis. // // This VName also serves as the default basis for any required inputs that // do not provide their own `v_name` field. As such, the general logic for // constructing VNames for entities arising a given source path should be: // // { // vname := unit.required_input[path].v_name // if vname.corpus is empty // vname.corpus := unit.v_name.corpus // vname.root := unit.v_name.root // if vname.path is empty // vname.path := path // } // // The above applies generally, but specific node kinds may have rules which // override this logic. VName *VName `protobuf:"bytes,1,opt,name=v_name,json=vName,proto3" json:"v_name,omitempty"` // All files that might be touched in the course of this compilation. // Consumers of the CompilationUnit may not assume anything about the order // of the elements of this field. RequiredInput []*CompilationUnit_FileInput `protobuf:"bytes,3,rep,name=required_input,json=requiredInput,proto3" json:"required_input,omitempty"` // Set by the extractor to indicate that the original input had compile // errors. This is used to check validity of the sharded analysis. HasCompileErrors bool `protobuf:"varint,4,opt,name=has_compile_errors,json=hasCompileErrors,proto3" json:"has_compile_errors,omitempty"` // The arguments to pass to a compiler tool for this compilation unit, // including the compiler executable, flags, and input files. Argument []string `protobuf:"bytes,5,rep,name=argument,proto3" json:"argument,omitempty"` // Of those files in `required_input`, the ones that this CompilationUnit // is intended to analyze. This is necessary to support languages like Go, // where a single translation unit may contain many source files that must all // be processed at once (while excluding source files that belong to other // CUs/packages, if any). SourceFile []string `protobuf:"bytes,6,rep,name=source_file,json=sourceFile,proto3" json:"source_file,omitempty"` // The output key of the CompilationUnit; for example, the object file that // it writes. The output key for a compilation should match the path in the // FileInfo message of a dependent compilation that consumes its output. OutputKey string `protobuf:"bytes,7,opt,name=output_key,json=outputKey,proto3" json:"output_key,omitempty"` // The absolute path of the current working directory where the build tool // was invoked. During analysis, a file whose path has working_directory // plus a path separator as an exact prefix is considered accessible from // that same path without said prefix. It is only necessary to set this // field if the build tool requires it. WorkingDirectory string `protobuf:"bytes,8,opt,name=working_directory,json=workingDirectory,proto3" json:"working_directory,omitempty"` // For languages that make use of resource contexts (like C++), the context // that should be initially entered. // TODO(zarko): What is a "resource context"? Needs a clear definition and/or // a link to one. EntryContext string `protobuf:"bytes,9,opt,name=entry_context,json=entryContext,proto3" json:"entry_context,omitempty"` // A collection of environment variables that the build environment expects // to be set. As a rule, we only record variables here that must be set to // specific values for the build to work. Users of this field may not assume // anything about the order of values; in particular the pipeline is free to // sort by name in order to canonicalize the message. Environment []*CompilationUnit_Env `protobuf:"bytes,10,rep,name=environment,proto3" json:"environment,omitempty"` // Per-language or per-tool details. Details []*anypb.Any `protobuf:"bytes,11,rep,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
Describes a single unit of compilation.
func (*CompilationUnit) Descriptor
deprecated
func (*CompilationUnit) Descriptor() ([]byte, []int)
Deprecated: Use CompilationUnit.ProtoReflect.Descriptor instead.
func (*CompilationUnit) GetArgument ¶
func (x *CompilationUnit) GetArgument() []string
func (*CompilationUnit) GetDetails ¶
func (x *CompilationUnit) GetDetails() []*anypb.Any
func (*CompilationUnit) GetEntryContext ¶
func (x *CompilationUnit) GetEntryContext() string
func (*CompilationUnit) GetEnvironment ¶
func (x *CompilationUnit) GetEnvironment() []*CompilationUnit_Env
func (*CompilationUnit) GetHasCompileErrors ¶
func (x *CompilationUnit) GetHasCompileErrors() bool
func (*CompilationUnit) GetOutputKey ¶
func (x *CompilationUnit) GetOutputKey() string
func (*CompilationUnit) GetRequiredInput ¶
func (x *CompilationUnit) GetRequiredInput() []*CompilationUnit_FileInput
func (*CompilationUnit) GetSourceFile ¶
func (x *CompilationUnit) GetSourceFile() []string
func (*CompilationUnit) GetVName ¶
func (x *CompilationUnit) GetVName() *VName
func (*CompilationUnit) GetWorkingDirectory ¶
func (x *CompilationUnit) GetWorkingDirectory() string
func (*CompilationUnit) ProtoMessage ¶
func (*CompilationUnit) ProtoMessage()
func (*CompilationUnit) ProtoReflect ¶
func (x *CompilationUnit) ProtoReflect() protoreflect.Message
func (*CompilationUnit) Reset ¶
func (x *CompilationUnit) Reset()
func (*CompilationUnit) String ¶
func (x *CompilationUnit) String() string
type CompilationUnit_Env ¶
type CompilationUnit_Env struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
An Env message represents the name and value of a single environment variable in the build environment.
func (*CompilationUnit_Env) Descriptor
deprecated
func (*CompilationUnit_Env) Descriptor() ([]byte, []int)
Deprecated: Use CompilationUnit_Env.ProtoReflect.Descriptor instead.
func (*CompilationUnit_Env) GetName ¶
func (x *CompilationUnit_Env) GetName() string
func (*CompilationUnit_Env) GetValue ¶
func (x *CompilationUnit_Env) GetValue() string
func (*CompilationUnit_Env) ProtoMessage ¶
func (*CompilationUnit_Env) ProtoMessage()
func (*CompilationUnit_Env) ProtoReflect ¶
func (x *CompilationUnit_Env) ProtoReflect() protoreflect.Message
func (*CompilationUnit_Env) Reset ¶
func (x *CompilationUnit_Env) Reset()
func (*CompilationUnit_Env) String ¶
func (x *CompilationUnit_Env) String() string
type CompilationUnit_FileInput ¶
type CompilationUnit_FileInput struct { // If set, overrides the `v_name` in the `CompilationUnit` for deriving // VNames during analysis. Values for fields which are not explicitly set // should be taken from the CompilationUnit's VName or (for path) FileInfo. VName *VName `protobuf:"bytes,1,opt,name=v_name,json=vName,proto3" json:"v_name,omitempty"` // The file's metadata. It is invalid to provide a FileInput without both // the file's path and digest. Info *FileInfo `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"` // Per-language or per-tool details. Details []*anypb.Any `protobuf:"bytes,4,rep,name=details,proto3" json:"details,omitempty"` // contains filtered or unexported fields }
func (*CompilationUnit_FileInput) Descriptor
deprecated
func (*CompilationUnit_FileInput) Descriptor() ([]byte, []int)
Deprecated: Use CompilationUnit_FileInput.ProtoReflect.Descriptor instead.
func (*CompilationUnit_FileInput) GetDetails ¶
func (x *CompilationUnit_FileInput) GetDetails() []*anypb.Any
func (*CompilationUnit_FileInput) GetInfo ¶
func (x *CompilationUnit_FileInput) GetInfo() *FileInfo
func (*CompilationUnit_FileInput) GetVName ¶
func (x *CompilationUnit_FileInput) GetVName() *VName
func (*CompilationUnit_FileInput) ProtoMessage ¶
func (*CompilationUnit_FileInput) ProtoMessage()
func (*CompilationUnit_FileInput) ProtoReflect ¶
func (x *CompilationUnit_FileInput) ProtoReflect() protoreflect.Message
func (*CompilationUnit_FileInput) Reset ¶
func (x *CompilationUnit_FileInput) Reset()
func (*CompilationUnit_FileInput) String ¶
func (x *CompilationUnit_FileInput) String() string
type CountReply ¶
type CountReply struct { // Total number of entries in the specified shard. Entries int64 `protobuf:"varint,1,opt,name=entries,proto3" json:"entries,omitempty"` // contains filtered or unexported fields }
Response for a CountRequest
func (*CountReply) Descriptor
deprecated
func (*CountReply) Descriptor() ([]byte, []int)
Deprecated: Use CountReply.ProtoReflect.Descriptor instead.
func (*CountReply) GetEntries ¶
func (x *CountReply) GetEntries() int64
func (*CountReply) ProtoMessage ¶
func (*CountReply) ProtoMessage()
func (*CountReply) ProtoReflect ¶
func (x *CountReply) ProtoReflect() protoreflect.Message
func (*CountReply) Reset ¶
func (x *CountReply) Reset()
func (*CountReply) String ¶
func (x *CountReply) String() string
type CountRequest ¶
type CountRequest struct { Index int64 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"` Shards int64 `protobuf:"varint,2,opt,name=shards,proto3" json:"shards,omitempty"` // contains filtered or unexported fields }
Request for the size of the shard at the given index.
func (*CountRequest) Descriptor
deprecated
func (*CountRequest) Descriptor() ([]byte, []int)
Deprecated: Use CountRequest.ProtoReflect.Descriptor instead.
func (*CountRequest) GetIndex ¶
func (x *CountRequest) GetIndex() int64
func (*CountRequest) GetShards ¶
func (x *CountRequest) GetShards() int64
func (*CountRequest) ProtoMessage ¶
func (*CountRequest) ProtoMessage()
func (*CountRequest) ProtoReflect ¶
func (x *CountRequest) ProtoReflect() protoreflect.Message
func (*CountRequest) Reset ¶
func (x *CountRequest) Reset()
func (*CountRequest) String ¶
func (x *CountRequest) String() string
type Entries ¶
type Entries struct { Entries []*Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"` // contains filtered or unexported fields }
A collection of Entry instances.
func (*Entries) Descriptor
deprecated
func (*Entries) GetEntries ¶
func (*Entries) ProtoMessage ¶
func (*Entries) ProtoMessage()
func (*Entries) ProtoReflect ¶
func (x *Entries) ProtoReflect() protoreflect.Message
type Entry ¶
type Entry struct { Source *VName `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"` // The following two fields must either be both empty, or both nonempty. EdgeKind string `protobuf:"bytes,2,opt,name=edge_kind,json=edgeKind,proto3" json:"edge_kind,omitempty"` Target *VName `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"` // The grammar for fact_name: // // name = "/" | 1*path // path = "/" word // word = 1*{LETTER|DIGIT|PUNCT} // LETTER = [A-Za-z] // DIGIT = [0-9] // PUNCT = [-.@#$%&_+:()] FactName string `protobuf:"bytes,4,opt,name=fact_name,json=factName,proto3" json:"fact_name,omitempty"` FactValue []byte `protobuf:"bytes,5,opt,name=fact_value,json=factValue,proto3" json:"fact_value,omitempty"` // contains filtered or unexported fields }
An Entry associates a fact with a graph object (node or edge). This is the the primary unit of storage.
func (*Entry) Descriptor
deprecated
func (*Entry) GetEdgeKind ¶
func (*Entry) GetFactName ¶
func (*Entry) GetFactValue ¶
func (*Entry) ProtoMessage ¶
func (*Entry) ProtoMessage()
func (*Entry) ProtoReflect ¶
func (x *Entry) ProtoReflect() protoreflect.Message
type FileData ¶
type FileData struct { // The content of the file, if known. If missing == true, this field must be // empty. Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"` // A (possibly normalized) copy of the non-empty fields of the FileInfo // message from the Get request. If either field from the original request // was empty, the server may optionally fill in that field in the reply if it // is known. For example, if the client requested a file by path only and // the server found it, the reply MAY fill in the digest. Info *FileInfo `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"` // If true, no data are available for the requested file, and the content // field must be empty. If false, the content field contains the complete // file content (which may be empty). Missing bool `protobuf:"varint,3,opt,name=missing,proto3" json:"missing,omitempty"` // contains filtered or unexported fields }
A FileData carries the content of a single file, as returned from the Get method of a FileDataService.
func (*FileData) Descriptor
deprecated
func (*FileData) GetContent ¶
func (*FileData) GetMissing ¶
func (*FileData) ProtoMessage ¶
func (*FileData) ProtoMessage()
func (*FileData) ProtoReflect ¶
func (x *FileData) ProtoReflect() protoreflect.Message
type FileInfo ¶
type FileInfo struct { // The path of the file relative to the working directory of the compilation // command, which is typically the root of the build. // For example: // // file/base/file.cc // ../../base/atomic_ref_count.h Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // The lowercase ascii hex SHA-256 digest of the file contents. Digest string `protobuf:"bytes,2,opt,name=digest,proto3" json:"digest,omitempty"` // contains filtered or unexported fields }
A FileInfo identifies a file used for analysis. At least one of the path and digest fields must be non-empty.
func (*FileInfo) Descriptor
deprecated
func (*FileInfo) ProtoMessage ¶
func (*FileInfo) ProtoMessage()
func (*FileInfo) ProtoReflect ¶
func (x *FileInfo) ProtoReflect() protoreflect.Message
type FilesRequest ¶
type FilesRequest struct { Files []*FileInfo `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"` // contains filtered or unexported fields }
A FilesRequest specifies a collection of files to be fetched from a FileDataService.
func (*FilesRequest) Descriptor
deprecated
func (*FilesRequest) Descriptor() ([]byte, []int)
Deprecated: Use FilesRequest.ProtoReflect.Descriptor instead.
func (*FilesRequest) GetFiles ¶
func (x *FilesRequest) GetFiles() []*FileInfo
func (*FilesRequest) ProtoMessage ¶
func (*FilesRequest) ProtoMessage()
func (*FilesRequest) ProtoReflect ¶
func (x *FilesRequest) ProtoReflect() protoreflect.Message
func (*FilesRequest) Reset ¶
func (x *FilesRequest) Reset()
func (*FilesRequest) String ¶
func (x *FilesRequest) String() string
type IndexedCompilation ¶
type IndexedCompilation struct { Unit *CompilationUnit `protobuf:"bytes,1,opt,name=unit,proto3" json:"unit,omitempty"` Index *IndexedCompilation_Index `protobuf:"bytes,2,opt,name=index,proto3" json:"index,omitempty"` // contains filtered or unexported fields }
A compilation unit combined with index terms.
func (*IndexedCompilation) Descriptor
deprecated
func (*IndexedCompilation) Descriptor() ([]byte, []int)
Deprecated: Use IndexedCompilation.ProtoReflect.Descriptor instead.
func (*IndexedCompilation) GetIndex ¶
func (x *IndexedCompilation) GetIndex() *IndexedCompilation_Index
func (*IndexedCompilation) GetUnit ¶
func (x *IndexedCompilation) GetUnit() *CompilationUnit
func (*IndexedCompilation) ProtoMessage ¶
func (*IndexedCompilation) ProtoMessage()
func (*IndexedCompilation) ProtoReflect ¶
func (x *IndexedCompilation) ProtoReflect() protoreflect.Message
func (*IndexedCompilation) Reset ¶
func (x *IndexedCompilation) Reset()
func (*IndexedCompilation) String ¶
func (x *IndexedCompilation) String() string
type IndexedCompilation_Index ¶
type IndexedCompilation_Index struct { // Revision markers at which this compilation record is indexed. Revisions []string `protobuf:"bytes,1,rep,name=revisions,proto3" json:"revisions,omitempty"` // contains filtered or unexported fields }
func (*IndexedCompilation_Index) Descriptor
deprecated
func (*IndexedCompilation_Index) Descriptor() ([]byte, []int)
Deprecated: Use IndexedCompilation_Index.ProtoReflect.Descriptor instead.
func (*IndexedCompilation_Index) GetRevisions ¶
func (x *IndexedCompilation_Index) GetRevisions() []string
func (*IndexedCompilation_Index) ProtoMessage ¶
func (*IndexedCompilation_Index) ProtoMessage()
func (*IndexedCompilation_Index) ProtoReflect ¶
func (x *IndexedCompilation_Index) ProtoReflect() protoreflect.Message
func (*IndexedCompilation_Index) Reset ¶
func (x *IndexedCompilation_Index) Reset()
func (*IndexedCompilation_Index) String ¶
func (x *IndexedCompilation_Index) String() string
type JarDetails ¶
type JarDetails struct { Jar []*JarDetails_Jar `protobuf:"bytes,1,rep,name=jar,proto3" json:"jar,omitempty"` // contains filtered or unexported fields }
CompilationUnit details enumerating the contents of each extracted .jar file.
func (*JarDetails) Descriptor
deprecated
func (*JarDetails) Descriptor() ([]byte, []int)
Deprecated: Use JarDetails.ProtoReflect.Descriptor instead.
func (*JarDetails) GetJar ¶
func (x *JarDetails) GetJar() []*JarDetails_Jar
func (*JarDetails) ProtoMessage ¶
func (*JarDetails) ProtoMessage()
func (*JarDetails) ProtoReflect ¶
func (x *JarDetails) ProtoReflect() protoreflect.Message
func (*JarDetails) Reset ¶
func (x *JarDetails) Reset()
func (*JarDetails) String ¶
func (x *JarDetails) String() string
type JarDetails_Jar ¶
type JarDetails_Jar struct { VName *VName `protobuf:"bytes,1,opt,name=v_name,json=vName,proto3" json:"v_name,omitempty"` // contains filtered or unexported fields }
func (*JarDetails_Jar) Descriptor
deprecated
func (*JarDetails_Jar) Descriptor() ([]byte, []int)
Deprecated: Use JarDetails_Jar.ProtoReflect.Descriptor instead.
func (*JarDetails_Jar) GetVName ¶
func (x *JarDetails_Jar) GetVName() *VName
func (*JarDetails_Jar) ProtoMessage ¶
func (*JarDetails_Jar) ProtoMessage()
func (*JarDetails_Jar) ProtoReflect ¶
func (x *JarDetails_Jar) ProtoReflect() protoreflect.Message
func (*JarDetails_Jar) Reset ¶
func (x *JarDetails_Jar) Reset()
func (*JarDetails_Jar) String ¶
func (x *JarDetails_Jar) String() string
type JarEntryDetails ¶
type JarEntryDetails struct { // Index into JarDetails for this file's jar container. JarContainer int32 `protobuf:"varint,1,opt,name=jar_container,json=jarContainer,proto3" json:"jar_container,omitempty"` // contains filtered or unexported fields }
CompilationUnit.FileInput details connecting a file to its enclosing jar.
func (*JarEntryDetails) Descriptor
deprecated
func (*JarEntryDetails) Descriptor() ([]byte, []int)
Deprecated: Use JarEntryDetails.ProtoReflect.Descriptor instead.
func (*JarEntryDetails) GetJarContainer ¶
func (x *JarEntryDetails) GetJarContainer() int32
func (*JarEntryDetails) ProtoMessage ¶
func (*JarEntryDetails) ProtoMessage()
func (*JarEntryDetails) ProtoReflect ¶
func (x *JarEntryDetails) ProtoReflect() protoreflect.Message
func (*JarEntryDetails) Reset ¶
func (x *JarEntryDetails) Reset()
func (*JarEntryDetails) String ¶
func (x *JarEntryDetails) String() string
type JavaDetails ¶
type JavaDetails struct { // List of classpaths used in the compilation. Classpath []string `protobuf:"bytes,1,rep,name=classpath,proto3" json:"classpath,omitempty"` // List of sourcepaths used in the compilation. Sourcepath []string `protobuf:"bytes,2,rep,name=sourcepath,proto3" json:"sourcepath,omitempty"` // List of bootclasspaths used in the compilation. Bootclasspath []string `protobuf:"bytes,3,rep,name=bootclasspath,proto3" json:"bootclasspath,omitempty"` // List of additional JavaC arguments identified by the extractor as // necessary for analysis, but not included in the argument list. ExtraJavacopts []string `protobuf:"bytes,10,rep,name=extra_javacopts,json=extraJavacopts,proto3" json:"extra_javacopts,omitempty"` // contains filtered or unexported fields }
Java-specific details used in a CompilationUnit. Its type is "kythe.io/proto/kythe.proto.JavaDetails".
func (*JavaDetails) Descriptor
deprecated
func (*JavaDetails) Descriptor() ([]byte, []int)
Deprecated: Use JavaDetails.ProtoReflect.Descriptor instead.
func (*JavaDetails) GetBootclasspath ¶
func (x *JavaDetails) GetBootclasspath() []string
func (*JavaDetails) GetClasspath ¶
func (x *JavaDetails) GetClasspath() []string
func (*JavaDetails) GetExtraJavacopts ¶
func (x *JavaDetails) GetExtraJavacopts() []string
func (*JavaDetails) GetSourcepath ¶
func (x *JavaDetails) GetSourcepath() []string
func (*JavaDetails) ProtoMessage ¶
func (*JavaDetails) ProtoMessage()
func (*JavaDetails) ProtoReflect ¶
func (x *JavaDetails) ProtoReflect() protoreflect.Message
func (*JavaDetails) Reset ¶
func (x *JavaDetails) Reset()
func (*JavaDetails) String ¶
func (x *JavaDetails) String() string
type KzipInfo ¶
type KzipInfo struct { // Map from corpus name to corpus info. Corpora map[string]*KzipInfo_CorpusInfo `` /* 155-byte string literal not displayed */ // Size in bytes of all the kzips that contributed to this KzipInfo. Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"` // The vname paths of required inputs should be relative to the root of the // repo. This field contains paths that erroneously contain a leading '/'. AbsolutePaths []string `protobuf:"bytes,6,rep,name=absolute_paths,json=absolutePaths,proto3" json:"absolute_paths,omitempty"` // Error messages detected when computing KzipInfo. For example, source files // with no corresponding required_input. If there are any items in this field, // it indicates that this kzip has serious problems and should not be used. CriticalKzipErrors []string `protobuf:"bytes,5,rep,name=critical_kzip_errors,json=criticalKzipErrors,proto3" json:"critical_kzip_errors,omitempty"` // contains filtered or unexported fields }
KzipInfo contains a summary of the contents of a kzip. It provides a breakdown of files and units by corpus and lanugage.
func (*KzipInfo) Descriptor
deprecated
func (*KzipInfo) GetAbsolutePaths ¶
func (*KzipInfo) GetCorpora ¶
func (x *KzipInfo) GetCorpora() map[string]*KzipInfo_CorpusInfo
func (*KzipInfo) GetCriticalKzipErrors ¶
func (*KzipInfo) ProtoMessage ¶
func (*KzipInfo) ProtoMessage()
func (*KzipInfo) ProtoReflect ¶
func (x *KzipInfo) ProtoReflect() protoreflect.Message
type KzipInfo_CorpusInfo ¶
type KzipInfo_CorpusInfo struct { // Map from language to count of required inputs that have this corpus in // their VName. LanguageRequiredInputs map[string]*KzipInfo_CorpusInfo_RequiredInputs `` /* 217-byte string literal not displayed */ // Map from language to count of sources that have this corpus in their // required_input VName. LanguageSources map[string]*KzipInfo_CorpusInfo_RequiredInputs `` /* 194-byte string literal not displayed */ // contains filtered or unexported fields }
func (*KzipInfo_CorpusInfo) Descriptor
deprecated
func (*KzipInfo_CorpusInfo) Descriptor() ([]byte, []int)
Deprecated: Use KzipInfo_CorpusInfo.ProtoReflect.Descriptor instead.
func (*KzipInfo_CorpusInfo) GetLanguageRequiredInputs ¶
func (x *KzipInfo_CorpusInfo) GetLanguageRequiredInputs() map[string]*KzipInfo_CorpusInfo_RequiredInputs
func (*KzipInfo_CorpusInfo) GetLanguageSources ¶
func (x *KzipInfo_CorpusInfo) GetLanguageSources() map[string]*KzipInfo_CorpusInfo_RequiredInputs
func (*KzipInfo_CorpusInfo) ProtoMessage ¶
func (*KzipInfo_CorpusInfo) ProtoMessage()
func (*KzipInfo_CorpusInfo) ProtoReflect ¶
func (x *KzipInfo_CorpusInfo) ProtoReflect() protoreflect.Message
func (*KzipInfo_CorpusInfo) Reset ¶
func (x *KzipInfo_CorpusInfo) Reset()
func (*KzipInfo_CorpusInfo) String ¶
func (x *KzipInfo_CorpusInfo) String() string
type KzipInfo_CorpusInfo_RequiredInputs ¶
type KzipInfo_CorpusInfo_RequiredInputs struct { // TODO(salguarnieri) Add count of unique inputs for this corpus? Count int32 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"` // contains filtered or unexported fields }
func (*KzipInfo_CorpusInfo_RequiredInputs) Descriptor
deprecated
func (*KzipInfo_CorpusInfo_RequiredInputs) Descriptor() ([]byte, []int)
Deprecated: Use KzipInfo_CorpusInfo_RequiredInputs.ProtoReflect.Descriptor instead.
func (*KzipInfo_CorpusInfo_RequiredInputs) GetCount ¶
func (x *KzipInfo_CorpusInfo_RequiredInputs) GetCount() int32
func (*KzipInfo_CorpusInfo_RequiredInputs) ProtoMessage ¶
func (*KzipInfo_CorpusInfo_RequiredInputs) ProtoMessage()
func (*KzipInfo_CorpusInfo_RequiredInputs) ProtoReflect ¶
func (x *KzipInfo_CorpusInfo_RequiredInputs) ProtoReflect() protoreflect.Message
func (*KzipInfo_CorpusInfo_RequiredInputs) Reset ¶
func (x *KzipInfo_CorpusInfo_RequiredInputs) Reset()
func (*KzipInfo_CorpusInfo_RequiredInputs) String ¶
func (x *KzipInfo_CorpusInfo_RequiredInputs) String() string
type ReadRequest ¶
type ReadRequest struct { // Return entries having this source VName, which may not be empty. Source *VName `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"` // Return entries having this edge kind; if empty, only entries with an empty // edge kind are returned; if "*", entries of any edge kind are returned. EdgeKind string `protobuf:"bytes,2,opt,name=edge_kind,json=edgeKind,proto3" json:"edge_kind,omitempty"` // contains filtered or unexported fields }
Request for a stream of Entry objects from a GraphStore. Read operations should be implemented with time complexity proportional to the size of the return set.
func (*ReadRequest) Descriptor
deprecated
func (*ReadRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.
func (*ReadRequest) GetEdgeKind ¶
func (x *ReadRequest) GetEdgeKind() string
func (*ReadRequest) GetSource ¶
func (x *ReadRequest) GetSource() *VName
func (*ReadRequest) ProtoMessage ¶
func (*ReadRequest) ProtoMessage()
func (*ReadRequest) ProtoReflect ¶
func (x *ReadRequest) ProtoReflect() protoreflect.Message
func (*ReadRequest) Reset ¶
func (x *ReadRequest) Reset()
func (*ReadRequest) String ¶
func (x *ReadRequest) String() string
type ScanRequest ¶
type ScanRequest struct { // Return entries having this target VName; if empty, any target field is // matched, including empty. Target *VName `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"` // Return entries having this kind; if empty, any kind is matched, including // empty. EdgeKind string `protobuf:"bytes,2,opt,name=edge_kind,json=edgeKind,proto3" json:"edge_kind,omitempty"` // Return entries having fact labels with this prefix; if empty, any fact // label is matched, FactPrefix string `protobuf:"bytes,3,opt,name=fact_prefix,json=factPrefix,proto3" json:"fact_prefix,omitempty"` // contains filtered or unexported fields }
Request for a stream of Entry objects resulting from a full scan of a GraphStore.
func (*ScanRequest) Descriptor
deprecated
func (*ScanRequest) Descriptor() ([]byte, []int)
Deprecated: Use ScanRequest.ProtoReflect.Descriptor instead.
func (*ScanRequest) GetEdgeKind ¶
func (x *ScanRequest) GetEdgeKind() string
func (*ScanRequest) GetFactPrefix ¶
func (x *ScanRequest) GetFactPrefix() string
func (*ScanRequest) GetTarget ¶
func (x *ScanRequest) GetTarget() *VName
func (*ScanRequest) ProtoMessage ¶
func (*ScanRequest) ProtoMessage()
func (*ScanRequest) ProtoReflect ¶
func (x *ScanRequest) ProtoReflect() protoreflect.Message
func (*ScanRequest) Reset ¶
func (x *ScanRequest) Reset()
func (*ScanRequest) String ¶
func (x *ScanRequest) String() string
type ShardRequest ¶
type ShardRequest struct { Index int64 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"` Shards int64 `protobuf:"varint,2,opt,name=shards,proto3" json:"shards,omitempty"` // contains filtered or unexported fields }
Request for a stream of Entry objects in the given shard.
func (*ShardRequest) Descriptor
deprecated
func (*ShardRequest) Descriptor() ([]byte, []int)
Deprecated: Use ShardRequest.ProtoReflect.Descriptor instead.
func (*ShardRequest) GetIndex ¶
func (x *ShardRequest) GetIndex() int64
func (*ShardRequest) GetShards ¶
func (x *ShardRequest) GetShards() int64
func (*ShardRequest) ProtoMessage ¶
func (*ShardRequest) ProtoMessage()
func (*ShardRequest) ProtoReflect ¶
func (x *ShardRequest) ProtoReflect() protoreflect.Message
func (*ShardRequest) Reset ¶
func (x *ShardRequest) Reset()
func (*ShardRequest) String ¶
func (x *ShardRequest) String() string
type VName ¶
type VName struct { // A language-specific signature assigned by the analyzer. // e.g., "com.google.common.collect.Lists.newLinkedList<#1>()" Signature string `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"` // The corpus this name belongs to. // e.g., "kythe", "chromium", "github.com/creachadair/imath", "aosp" // The corpus label "kythe" is reserved for internal use. Corpus string `protobuf:"bytes,2,opt,name=corpus,proto3" json:"corpus,omitempty"` // A corpus-specific root label, designating a subordinate collection within // the corpus. If a corpus stores files in unrelated directory structures, // for example, the root can be used to distinguish them. Or, if a corpus // incorporates subprojects, the root can be a project ID that it governs. // This may also be used to distinguish virtual subgroups of a corpus such as // generated files. Root string `protobuf:"bytes,3,opt,name=root,proto3" json:"root,omitempty"` // A path-structured label describing the location of this object relative to // the corpus and the root. For code, this will generally be the relative // path to the file containing the code, e.g., "storage/service.go" in kythe. // The individual elements of the path are separated by "/". // The path must not start with "/". // The path must be normalized to a canonical form (with no path // elements "", ".", or ".."). // // However, this need not be a true file path; virtual objects like figments // can assign an ad-hoc abstract ID, or omit it entirely. // // Examples: // // "devools/kythe/platform/go/datastore.go" (a file) // "type/cpp/void.cc" (a type figment) Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"` // The language this name belongs to. // e.g., "c++", "python", "elisp", "haskell", "java" // // The schema will define specific labels for each supported language, so we // don't wind up with a confusion of names like "cxx", "cpp", "C++", etc. // Prototype: Official language name converted to lowercase. If a version // number is necessary, include it, e.g., "python3". Language string `protobuf:"bytes,5,opt,name=language,proto3" json:"language,omitempty"` // contains filtered or unexported fields }
VName is a proto representation of a vector name. See also https://kythe.io/docs/kythe-storage.html#_a_id_termvname_a_vector_name_strong_vname_strong
Rules:
- All fields must be optional, and must have default values.
- No field may ever be removed. If a field is deprecated, it may be renamed or marked with a comment, but must not be deleted.
- New fields are always added to the end of the message.
- All fields must be strings, not messages.
One of the key principles is that we want as few fields as possible in a vname. We're not trying to exhaust the possible dimensions along which a name could vary, but to find a minimal basis. Be conservative.
func (*VName) Descriptor
deprecated
func (*VName) GetLanguage ¶
func (*VName) GetSignature ¶
func (*VName) ProtoMessage ¶
func (*VName) ProtoMessage()
func (*VName) ProtoReflect ¶
func (x *VName) ProtoReflect() protoreflect.Message
type VNameMask ¶
type VNameMask struct { Signature bool `protobuf:"varint,1,opt,name=signature,proto3" json:"signature,omitempty"` Corpus bool `protobuf:"varint,2,opt,name=corpus,proto3" json:"corpus,omitempty"` Root bool `protobuf:"varint,3,opt,name=root,proto3" json:"root,omitempty"` Path bool `protobuf:"varint,4,opt,name=path,proto3" json:"path,omitempty"` Language bool `protobuf:"varint,5,opt,name=language,proto3" json:"language,omitempty"` // contains filtered or unexported fields }
func (*VNameMask) Descriptor
deprecated
func (*VNameMask) GetLanguage ¶
func (*VNameMask) GetSignature ¶
func (*VNameMask) ProtoMessage ¶
func (*VNameMask) ProtoMessage()
func (*VNameMask) ProtoReflect ¶
func (x *VNameMask) ProtoReflect() protoreflect.Message
type VNameRewriteRule ¶
type VNameRewriteRule struct { // An RE2 pattern to match against an input string. Patterns are implicitly // anchored at both ends. Pattern string `protobuf:"bytes,1,opt,name=pattern,proto3" json:"pattern,omitempty"` // A template VName to populate with matches from the input. The template // strings may contain markers of the form @n@, that will be replaced by the // n'th regexp group on a successful input match. VName *VName `protobuf:"bytes,2,opt,name=v_name,json=vname,proto3" json:"v_name,omitempty"` // contains filtered or unexported fields }
A VNameRewriteRule associates a regular expression pattern with a VName template. A rule can be applied to a string to produce a VName.
func (*VNameRewriteRule) Descriptor
deprecated
func (*VNameRewriteRule) Descriptor() ([]byte, []int)
Deprecated: Use VNameRewriteRule.ProtoReflect.Descriptor instead.
func (*VNameRewriteRule) GetPattern ¶
func (x *VNameRewriteRule) GetPattern() string
func (*VNameRewriteRule) GetVName ¶
func (x *VNameRewriteRule) GetVName() *VName
func (*VNameRewriteRule) ProtoMessage ¶
func (*VNameRewriteRule) ProtoMessage()
func (*VNameRewriteRule) ProtoReflect ¶
func (x *VNameRewriteRule) ProtoReflect() protoreflect.Message
func (*VNameRewriteRule) Reset ¶
func (x *VNameRewriteRule) Reset()
func (*VNameRewriteRule) String ¶
func (x *VNameRewriteRule) String() string
type VNameRewriteRules ¶
type VNameRewriteRules struct { Rule []*VNameRewriteRule `protobuf:"bytes,1,rep,name=rule,proto3" json:"rule,omitempty"` // contains filtered or unexported fields }
VNameRewriteRules is a container for multiple VNameRewriteRules.
func (*VNameRewriteRules) Descriptor
deprecated
func (*VNameRewriteRules) Descriptor() ([]byte, []int)
Deprecated: Use VNameRewriteRules.ProtoReflect.Descriptor instead.
func (*VNameRewriteRules) GetRule ¶
func (x *VNameRewriteRules) GetRule() []*VNameRewriteRule
func (*VNameRewriteRules) ProtoMessage ¶
func (*VNameRewriteRules) ProtoMessage()
func (*VNameRewriteRules) ProtoReflect ¶
func (x *VNameRewriteRules) ProtoReflect() protoreflect.Message
func (*VNameRewriteRules) Reset ¶
func (x *VNameRewriteRules) Reset()
func (*VNameRewriteRules) String ¶
func (x *VNameRewriteRules) String() string
type WriteReply ¶
type WriteReply struct {
// contains filtered or unexported fields
}
Response to a WriteRequest
func (*WriteReply) Descriptor
deprecated
func (*WriteReply) Descriptor() ([]byte, []int)
Deprecated: Use WriteReply.ProtoReflect.Descriptor instead.
func (*WriteReply) ProtoMessage ¶
func (*WriteReply) ProtoMessage()
func (*WriteReply) ProtoReflect ¶
func (x *WriteReply) ProtoReflect() protoreflect.Message
func (*WriteReply) Reset ¶
func (x *WriteReply) Reset()
func (*WriteReply) String ¶
func (x *WriteReply) String() string
type WriteRequest ¶
type WriteRequest struct { Source *VName `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"` Update []*WriteRequest_Update `protobuf:"bytes,2,rep,name=update,proto3" json:"update,omitempty"` // contains filtered or unexported fields }
Request to write Entry objects to a GraphStore
func (*WriteRequest) Descriptor
deprecated
func (*WriteRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.
func (*WriteRequest) GetSource ¶
func (x *WriteRequest) GetSource() *VName
func (*WriteRequest) GetUpdate ¶
func (x *WriteRequest) GetUpdate() []*WriteRequest_Update
func (*WriteRequest) ProtoMessage ¶
func (*WriteRequest) ProtoMessage()
func (*WriteRequest) ProtoReflect ¶
func (x *WriteRequest) ProtoReflect() protoreflect.Message
func (*WriteRequest) Reset ¶
func (x *WriteRequest) Reset()
func (*WriteRequest) String ¶
func (x *WriteRequest) String() string
type WriteRequest_Update ¶
type WriteRequest_Update struct { EdgeKind string `protobuf:"bytes,1,opt,name=edge_kind,json=edgeKind,proto3" json:"edge_kind,omitempty"` Target *VName `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"` FactName string `protobuf:"bytes,3,opt,name=fact_name,json=factName,proto3" json:"fact_name,omitempty"` FactValue []byte `protobuf:"bytes,4,opt,name=fact_value,json=factValue,proto3" json:"fact_value,omitempty"` // contains filtered or unexported fields }
func (*WriteRequest_Update) Descriptor
deprecated
func (*WriteRequest_Update) Descriptor() ([]byte, []int)
Deprecated: Use WriteRequest_Update.ProtoReflect.Descriptor instead.
func (*WriteRequest_Update) GetEdgeKind ¶
func (x *WriteRequest_Update) GetEdgeKind() string
func (*WriteRequest_Update) GetFactName ¶
func (x *WriteRequest_Update) GetFactName() string
func (*WriteRequest_Update) GetFactValue ¶
func (x *WriteRequest_Update) GetFactValue() []byte
func (*WriteRequest_Update) GetTarget ¶
func (x *WriteRequest_Update) GetTarget() *VName
func (*WriteRequest_Update) ProtoMessage ¶
func (*WriteRequest_Update) ProtoMessage()
func (*WriteRequest_Update) ProtoReflect ¶
func (x *WriteRequest_Update) ProtoReflect() protoreflect.Message
func (*WriteRequest_Update) Reset ¶
func (x *WriteRequest_Update) Reset()
func (*WriteRequest_Update) String ¶
func (x *WriteRequest_Update) String() string