shipshape_rpc_proto_go_src

Documentation

Overview

Package shipshape_rpc_proto_go_src is a generated protocol buffer package.

It is generated from these files:

shipshape/proto/shipshape_rpc.proto

It has these top-level messages:

GetCategoryRequest
GetCategoryResponse
GetStageRequest
GetStageResponse
AnalyzeRequest
AnalysisFailure
AnalyzeResponse
ShipshapeRequest
ShipshapeResponse

Index

• type AnalysisFailure
  • func (m *AnalysisFailure) GetCategory() string
  • func (m *AnalysisFailure) GetFailureMessage() string
  • func (*AnalysisFailure) ProtoMessage()
  • func (m *AnalysisFailure) Reset()
  • func (m *AnalysisFailure) String() string
• type AnalyzeRequest
  • func (m *AnalyzeRequest) GetCategory() []string
  • func (m *AnalyzeRequest) GetShipshapeContext() *shipshape_proto2.ShipshapeContext
  • func (*AnalyzeRequest) ProtoMessage()
  • func (m *AnalyzeRequest) Reset()
  • func (m *AnalyzeRequest) String() string
• type AnalyzeResponse
  • func (m *AnalyzeResponse) GetFailure() []*AnalysisFailure
  • func (m *AnalyzeResponse) GetNote() []*shipshape_proto1.Note
  • func (*AnalyzeResponse) ProtoMessage()
  • func (m *AnalyzeResponse) Reset()
  • func (m *AnalyzeResponse) String() string
• type GetCategoryRequest
  • func (*GetCategoryRequest) ProtoMessage()
  • func (m *GetCategoryRequest) Reset()
  • func (m *GetCategoryRequest) String() string
• type GetCategoryResponse
  • func (m *GetCategoryResponse) GetCategory() []string
  • func (*GetCategoryResponse) ProtoMessage()
  • func (m *GetCategoryResponse) Reset()
  • func (m *GetCategoryResponse) String() string
• type GetStageRequest
  • func (*GetStageRequest) ProtoMessage()
  • func (m *GetStageRequest) Reset()
  • func (m *GetStageRequest) String() string
• type GetStageResponse
  • func (m *GetStageResponse) GetStage() shipshape_proto2.Stage
  • func (*GetStageResponse) ProtoMessage()
  • func (m *GetStageResponse) Reset()
  • func (m *GetStageResponse) String() string
• type ShipshapeRequest
  • func (m *ShipshapeRequest) GetEvent() string
  • func (m *ShipshapeRequest) GetShipshapeContext() *shipshape_proto2.ShipshapeContext
  • func (m *ShipshapeRequest) GetStage() shipshape_proto2.Stage
  • func (m *ShipshapeRequest) GetTriggeredCategory() []string
  • func (*ShipshapeRequest) ProtoMessage()
  • func (m *ShipshapeRequest) Reset()
  • func (m *ShipshapeRequest) String() string
• type ShipshapeResponse
  • func (m *ShipshapeResponse) GetAnalyzeResponse() []*AnalyzeResponse
  • func (*ShipshapeResponse) ProtoMessage()
  • func (m *ShipshapeResponse) Reset()
  • func (m *ShipshapeResponse) String() string

Types

type AnalysisFailure

type AnalysisFailure struct {
	Category         *string `protobuf:"bytes,1,opt,name=category" json:"category,omitempty"`
	FailureMessage   *string `protobuf:"bytes,2,opt,name=failure_message" json:"failure_message,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

func (*AnalysisFailure) GetCategory

func (m *AnalysisFailure) GetCategory() string

func (*AnalysisFailure) GetFailureMessage

func (m *AnalysisFailure) GetFailureMessage() string

func (*AnalysisFailure) ProtoMessage

func (*AnalysisFailure) ProtoMessage()

func (*AnalysisFailure) Reset

func (m *AnalysisFailure) Reset()

func (*AnalysisFailure) String

func (m *AnalysisFailure) String() string

type AnalyzeRequest

type AnalyzeRequest struct {
	ShipshapeContext *shipshape_proto2.ShipshapeContext `protobuf:"bytes,1,opt,name=shipshape_context" json:"shipshape_context,omitempty"`
	Category         []string                           `protobuf:"bytes,2,rep,name=category" json:"category,omitempty"`
	XXX_unrecognized []byte                             `json:"-"`
}

Provides information to an analyzer to perform its analysis.

func (*AnalyzeRequest) GetCategory

func (m *AnalyzeRequest) GetCategory() []string

func (*AnalyzeRequest) GetShipshapeContext

func (m *AnalyzeRequest) GetShipshapeContext() *shipshape_proto2.ShipshapeContext

func (*AnalyzeRequest) ProtoMessage

func (*AnalyzeRequest) ProtoMessage()

func (*AnalyzeRequest) Reset

func (m *AnalyzeRequest) Reset()

func (*AnalyzeRequest) String

func (m *AnalyzeRequest) String() string

type AnalyzeResponse

type AnalyzeResponse struct {
	Note             []*shipshape_proto1.Note `protobuf:"bytes,1,rep,name=note" json:"note,omitempty"`
	Failure          []*AnalysisFailure       `protobuf:"bytes,2,rep,name=failure" json:"failure,omitempty"`
	XXX_unrecognized []byte                   `json:"-"`
}

Describes the results of an analysis, whether complete or failed. If an analysis run completes successfully but produces no notes, just return an empty list. If the analyzer fails, return a failure_message. Analyzers may also return partial results (only a subset of the notes) in this case.

func (*AnalyzeResponse) GetFailure

func (m *AnalyzeResponse) GetFailure() []*AnalysisFailure

func (*AnalyzeResponse) GetNote

func (m *AnalyzeResponse) GetNote() []*shipshape_proto1.Note

func (*AnalyzeResponse) ProtoMessage

func (*AnalyzeResponse) ProtoMessage()

func (*AnalyzeResponse) Reset

func (m *AnalyzeResponse) Reset()

func (*AnalyzeResponse) String

func (m *AnalyzeResponse) String() string

type GetCategoryRequest

type GetCategoryRequest struct {
	XXX_unrecognized []byte `json:"-"`
}

func (*GetCategoryRequest) ProtoMessage

func (*GetCategoryRequest) ProtoMessage()

func (*GetCategoryRequest) Reset

func (m *GetCategoryRequest) Reset()

func (*GetCategoryRequest) String

func (m *GetCategoryRequest) String() string

type GetCategoryResponse

type GetCategoryResponse struct {
	// List of analysis categories available.
	// For individual analyzers, this list should have one element.
	// Dispatching analyzers (implementation details for Shipshape) can
	// return multiple categories.
	// Should match requirements in the category field for Notes.
	Category         []string `protobuf:"bytes,1,rep,name=category" json:"category,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}

Tells the environment what analyses are available at this service.

func (*GetCategoryResponse) GetCategory

func (m *GetCategoryResponse) GetCategory() []string

func (*GetCategoryResponse) ProtoMessage

func (*GetCategoryResponse) ProtoMessage()

func (*GetCategoryResponse) Reset

func (m *GetCategoryResponse) Reset()

func (*GetCategoryResponse) String

func (m *GetCategoryResponse) String() string

type GetStageRequest

type GetStageRequest struct {
	XXX_unrecognized []byte `json:"-"`
}

func (*GetStageRequest) ProtoMessage

func (*GetStageRequest) ProtoMessage()

func (*GetStageRequest) Reset

func (m *GetStageRequest) Reset()

func (*GetStageRequest) String

func (m *GetStageRequest) String() string

type GetStageResponse

type GetStageResponse struct {
	Stage            *shipshape_proto2.Stage `protobuf:"varint,1,opt,name=stage,enum=shipshape_proto.Stage" json:"stage,omitempty"`
	XXX_unrecognized []byte                  `json:"-"`
}

Tells the environment what stage the analyzer can run in.

func (*GetStageResponse) GetStage

func (m *GetStageResponse) GetStage() shipshape_proto2.Stage

func (*GetStageResponse) ProtoMessage

func (*GetStageResponse) ProtoMessage()

func (*GetStageResponse) Reset

func (m *GetStageResponse) Reset()

func (*GetStageResponse) String

func (m *GetStageResponse) String() string

type ShipshapeRequest

type ShipshapeRequest struct {
	// The ShipshapeContext to use for this run
	ShipshapeContext *shipshape_proto2.ShipshapeContext `protobuf:"bytes,1,opt,name=shipshape_context" json:"shipshape_context,omitempty"`
	// Explicitly triggered categories. If empty will run what is in config files.
	// Will only run the triggered categories.
	TriggeredCategory []string `protobuf:"bytes,2,rep,name=triggered_category" json:"triggered_category,omitempty"`
	// The event we are running for
	Event *string `protobuf:"bytes,3,opt,name=event" json:"event,omitempty"`
	// Which stage to run
	Stage            *shipshape_proto2.Stage `protobuf:"varint,4,opt,name=stage,enum=shipshape_proto.Stage" json:"stage,omitempty"`
	XXX_unrecognized []byte                  `json:"-"`
}

func (*ShipshapeRequest) GetEvent

func (m *ShipshapeRequest) GetEvent() string

func (*ShipshapeRequest) GetShipshapeContext

func (m *ShipshapeRequest) GetShipshapeContext() *shipshape_proto2.ShipshapeContext

func (*ShipshapeRequest) GetStage

func (m *ShipshapeRequest) GetStage() shipshape_proto2.Stage

func (*ShipshapeRequest) GetTriggeredCategory

func (m *ShipshapeRequest) GetTriggeredCategory() []string

func (*ShipshapeRequest) ProtoMessage

func (*ShipshapeRequest) ProtoMessage()

func (*ShipshapeRequest) Reset

func (m *ShipshapeRequest) Reset()

func (*ShipshapeRequest) String

func (m *ShipshapeRequest) String() string

type ShipshapeResponse

type ShipshapeResponse struct {
	AnalyzeResponse  []*AnalyzeResponse `protobuf:"bytes,1,rep,name=analyze_response" json:"analyze_response,omitempty"`
	XXX_unrecognized []byte             `json:"-"`
}

func (*ShipshapeResponse) GetAnalyzeResponse

func (m *ShipshapeResponse) GetAnalyzeResponse() []*AnalyzeResponse

func (*ShipshapeResponse) ProtoMessage

func (*ShipshapeResponse) ProtoMessage()

func (*ShipshapeResponse) Reset

func (m *ShipshapeResponse) Reset()

func (*ShipshapeResponse) String

func (m *ShipshapeResponse) String() string