Documentation ¶
Overview ¶
Package shipshape_context_proto_go_src is a generated protocol buffer package.
It is generated from these files:
shipshape/proto/shipshape_context.proto
It has these top-level messages:
ShipshapeContext ChangelistDetails CompilationDetails
Index ¶
- Variables
- type ChangelistDetails
- func (m *ChangelistDetails) GetChangelist() string
- func (m *ChangelistDetails) GetChangelistAuthor() string
- func (m *ChangelistDetails) GetChangelistCc() []string
- func (m *ChangelistDetails) GetChangelistDescription() string
- func (m *ChangelistDetails) GetChangelistReviewer() []string
- func (m *ChangelistDetails) GetClientName() string
- func (m *ChangelistDetails) GetDeletedFilePath() []string
- func (*ChangelistDetails) ProtoMessage()
- func (m *ChangelistDetails) Reset()
- func (m *ChangelistDetails) String() string
- type CompilationDetails
- type ShipshapeContext
- func (m *ShipshapeContext) GetChangelistDetails() *ChangelistDetails
- func (m *ShipshapeContext) GetCompilationDetails() *CompilationDetails
- func (m *ShipshapeContext) GetEnvironment() ShipshapeContext_Environment
- func (m *ShipshapeContext) GetFilePath() []string
- func (m *ShipshapeContext) GetRepoRoot() string
- func (m *ShipshapeContext) GetSourceContext() *source_v1.SourceContext
- func (*ShipshapeContext) ProtoMessage()
- func (m *ShipshapeContext) Reset()
- func (m *ShipshapeContext) String() string
- type ShipshapeContext_Environment
- type Stage
Constants ¶
This section is empty.
Variables ¶
View Source
var ShipshapeContext_Environment_name = map[int32]string{
1: "CODE_REVIEW",
2: "LOCAL_CLIENT",
3: "BATCH",
4: "IDE",
5: "POST_SUBMIT",
}
View Source
var ShipshapeContext_Environment_value = map[string]int32{
"CODE_REVIEW": 1,
"LOCAL_CLIENT": 2,
"BATCH": 3,
"IDE": 4,
"POST_SUBMIT": 5,
}
View Source
var Stage_name = map[int32]string{
1: "PRE_BUILD",
2: "POST_BUILD",
}
View Source
var Stage_value = map[string]int32{
"PRE_BUILD": 1,
"POST_BUILD": 2,
}
Functions ¶
This section is empty.
Types ¶
type ChangelistDetails ¶
type ChangelistDetails struct { // Commit or changelist id. Changelist *string `protobuf:"bytes,1,opt,name=changelist" json:"changelist,omitempty"` ChangelistAuthor *string `protobuf:"bytes,2,opt,name=changelist_author" json:"changelist_author,omitempty"` ChangelistReviewer []string `protobuf:"bytes,3,rep,name=changelist_reviewer" json:"changelist_reviewer,omitempty"` ChangelistCc []string `protobuf:"bytes,4,rep,name=changelist_cc" json:"changelist_cc,omitempty"` ChangelistDescription *string `protobuf:"bytes,5,opt,name=changelist_description" json:"changelist_description,omitempty"` // List of files that are deleted in the changelist. DeletedFilePath []string `protobuf:"bytes,6,rep,name=deleted_file_path" json:"deleted_file_path,omitempty"` ClientName *string `protobuf:"bytes,7,opt,name=client_name" json:"client_name,omitempty"` XXX_unrecognized []byte `json:"-"` }
Provides data describing a changelist, including code review related information.
func (*ChangelistDetails) GetChangelist ¶
func (m *ChangelistDetails) GetChangelist() string
func (*ChangelistDetails) GetChangelistAuthor ¶
func (m *ChangelistDetails) GetChangelistAuthor() string
func (*ChangelistDetails) GetChangelistCc ¶
func (m *ChangelistDetails) GetChangelistCc() []string
func (*ChangelistDetails) GetChangelistDescription ¶
func (m *ChangelistDetails) GetChangelistDescription() string
func (*ChangelistDetails) GetChangelistReviewer ¶
func (m *ChangelistDetails) GetChangelistReviewer() []string
func (*ChangelistDetails) GetClientName ¶
func (m *ChangelistDetails) GetClientName() string
func (*ChangelistDetails) GetDeletedFilePath ¶
func (m *ChangelistDetails) GetDeletedFilePath() []string
func (*ChangelistDetails) ProtoMessage ¶
func (*ChangelistDetails) ProtoMessage()
func (*ChangelistDetails) Reset ¶
func (m *ChangelistDetails) Reset()
func (*ChangelistDetails) String ¶
func (m *ChangelistDetails) String() string
type CompilationDetails ¶
type CompilationDetails struct { // Set when running compiler based analysis; compilation_details describes // a single invocation of a compiler. // optional kythe.proto.CompilationUnit compilation_unit = 1; // The local path to a compilation description file (.kindex) // that this compilation unit came from. CompilationDescriptionPath *string `protobuf:"bytes,2,opt,name=compilation_description_path" json:"compilation_description_path,omitempty"` XXX_unrecognized []byte `json:"-"` }
Provides information about a specific compilation
func (*CompilationDetails) GetCompilationDescriptionPath ¶
func (m *CompilationDetails) GetCompilationDescriptionPath() string
func (*CompilationDetails) ProtoMessage ¶
func (*CompilationDetails) ProtoMessage()
func (*CompilationDetails) Reset ¶
func (m *CompilationDetails) Reset()
func (*CompilationDetails) String ¶
func (m *CompilationDetails) String() string
type ShipshapeContext ¶
type ShipshapeContext struct { // Where is the analysis running, used to make decisions to tweak // the analysis. Environment *ShipshapeContext_Environment `protobuf:"varint,1,opt,name=environment,enum=shipshape_proto.ShipshapeContext_Environment" json:"environment,omitempty"` // The source_context describes the source code repository analyzed. SourceContext *source_v1.SourceContext `protobuf:"bytes,2,opt,name=source_context" json:"source_context,omitempty"` // Current list of file patterns to analyze, from repo root FilePath []string `protobuf:"bytes,3,rep,name=file_path" json:"file_path,omitempty"` // Path to the repo_root locally. All files can be read from in this // directory. If no file_paths are specified, will analyze all files // available from the root. RepoRoot *string `protobuf:"bytes,4,opt,name=repo_root" json:"repo_root,omitempty"` // Set only when analysis is run in the context of a changelist. // e.g. a Code Review ChangelistDetails *ChangelistDetails `protobuf:"bytes,5,opt,name=changelist_details" json:"changelist_details,omitempty"` // TODO(supertri): Do we need dependency details, or build details? CompilationDetails *CompilationDetails `protobuf:"bytes,8,opt,name=compilation_details" json:"compilation_details,omitempty"` XXX_unrecognized []byte `json:"-"` }
Root object that provides access to information about the environment the analysis is running in.
func (*ShipshapeContext) GetChangelistDetails ¶
func (m *ShipshapeContext) GetChangelistDetails() *ChangelistDetails
func (*ShipshapeContext) GetCompilationDetails ¶
func (m *ShipshapeContext) GetCompilationDetails() *CompilationDetails
func (*ShipshapeContext) GetEnvironment ¶
func (m *ShipshapeContext) GetEnvironment() ShipshapeContext_Environment
func (*ShipshapeContext) GetFilePath ¶
func (m *ShipshapeContext) GetFilePath() []string
func (*ShipshapeContext) GetRepoRoot ¶
func (m *ShipshapeContext) GetRepoRoot() string
func (*ShipshapeContext) GetSourceContext ¶
func (m *ShipshapeContext) GetSourceContext() *source_v1.SourceContext
func (*ShipshapeContext) ProtoMessage ¶
func (*ShipshapeContext) ProtoMessage()
func (*ShipshapeContext) Reset ¶
func (m *ShipshapeContext) Reset()
func (*ShipshapeContext) String ¶
func (m *ShipshapeContext) String() string
type ShipshapeContext_Environment ¶
type ShipshapeContext_Environment int32
const ( ShipshapeContext_CODE_REVIEW ShipshapeContext_Environment = 1 ShipshapeContext_LOCAL_CLIENT ShipshapeContext_Environment = 2 ShipshapeContext_BATCH ShipshapeContext_Environment = 3 ShipshapeContext_IDE ShipshapeContext_Environment = 4 ShipshapeContext_POST_SUBMIT ShipshapeContext_Environment = 5 )
func (ShipshapeContext_Environment) Enum ¶
func (x ShipshapeContext_Environment) Enum() *ShipshapeContext_Environment
func (ShipshapeContext_Environment) String ¶
func (x ShipshapeContext_Environment) String() string
func (*ShipshapeContext_Environment) UnmarshalJSON ¶
func (x *ShipshapeContext_Environment) UnmarshalJSON(data []byte) error
type Stage ¶
type Stage int32
Indicates what stage of Shipshape to plug in to or Shipshape is running in.
func (*Stage) UnmarshalJSON ¶
Click to show internal directories.
Click to hide internal directories.