modules

Documentation

Index

• type BackendOptimizer
• type BackendSerializer
• type BackendTargetGenerator
• type FqdnResolver
• type MiddleendVisitor
  • func NewVisitor(debugger pgs.DebuggerCommon) *MiddleendVisitor
  • func (v *MiddleendVisitor) VisitEnum(enum pgs.Enum) (pgs.Visitor, error)
  • func (v *MiddleendVisitor) VisitField(field pgs.Field) (pgs.Visitor, error)
  • func (v *MiddleendVisitor) VisitMessage(message pgs.Message) (pgs.Visitor, error)
• type Module
  • func NewModule() *Module
  • func (m *Module) BackendPhase(file pgs.File, registry *jsonschema.Registry, optimizer BackendOptimizer, ...) pgs.Artifact
  • func (m *Module) Execute(targets map[string]pgs.File, packages map[string]pgs.Package) []pgs.Artifact
  • func (m *Module) InitContext(c pgs.BuildContext)
  • func (m *Module) Name() string
• type MultiDraftGenerator
  • func NewMultiDraftGenerator(pluginOptions *proto.PluginOptions) *MultiDraftGenerator
  • func (g *MultiDraftGenerator) Generate(registry *jsonschema.Registry, entrypointMessage pgs.Message, ...) any
• type OptimizerImpl
  • func NewOptimizerImpl(pluginOptions *proto.PluginOptions) *OptimizerImpl
  • func (o *OptimizerImpl) Optimize(registry *jsonschema.Registry, entrypointMessage pgs.Message)
• type SerializerImpl
  • func NewSerializerImpl(pluginOptions *proto.PluginOptions) *SerializerImpl
  • func (s *SerializerImpl) Serialize(schema any, file pgs.File) ([]byte, error)
  • func (s *SerializerImpl) ToFileName(file pgs.File) string
• type WellKnownFieldType
• type WellKnownMessageType

Types

type BackendOptimizer

type BackendOptimizer interface {
	Optimize(registry *jsonschema.Registry, entrypointMessage pgs.Message)
}

type BackendSerializer

type BackendSerializer interface {
	Serialize(schema any, file pgs.File) ([]byte, error)
	ToFileName(file pgs.File) string
}

type BackendTargetGenerator

type BackendTargetGenerator interface {
	Generate(registry *jsonschema.Registry, entrypointMessage pgs.Message, fileOptions *proto.FileOptions) any
}

type FqdnResolver

type FqdnResolver interface {
	FullyQualifiedName() string
}

type MiddleendVisitor

type MiddleendVisitor struct {
	pgs.Visitor
	// contains filtered or unexported fields
}

MiddleendVisitor generate intermediate jsonschema from protobuf

func NewVisitor

func NewVisitor(debugger pgs.DebuggerCommon) *MiddleendVisitor

func (*MiddleendVisitor) VisitEnum

func (v *MiddleendVisitor) VisitEnum(enum pgs.Enum) (pgs.Visitor, error)

func (*MiddleendVisitor) VisitField

func (v *MiddleendVisitor) VisitField(field pgs.Field) (pgs.Visitor, error)

func (*MiddleendVisitor) VisitMessage

func (v *MiddleendVisitor) VisitMessage(message pgs.Message) (pgs.Visitor, error)

type Module

type Module struct {
	*pgs.ModuleBase
	// contains filtered or unexported fields
}

func NewModule

func NewModule() *Module

func (*Module) BackendPhase

func (m *Module) BackendPhase(file pgs.File, registry *jsonschema.Registry, optimizer BackendOptimizer, generator BackendTargetGenerator, serializer BackendSerializer) pgs.Artifact

func (*Module) Execute

func (m *Module) Execute(targets map[string]pgs.File, packages map[string]pgs.Package) []pgs.Artifact

func (*Module) InitContext

func (m *Module) InitContext(c pgs.BuildContext)

func (*Module) Name

func (m *Module) Name() string

type MultiDraftGenerator

type MultiDraftGenerator struct {
	// contains filtered or unexported fields
}

func NewMultiDraftGenerator

func NewMultiDraftGenerator(pluginOptions *proto.PluginOptions) *MultiDraftGenerator

func (*MultiDraftGenerator) Generate

func (g *MultiDraftGenerator) Generate(registry *jsonschema.Registry, entrypointMessage pgs.Message, fileOptions *proto.FileOptions) any

type OptimizerImpl

type OptimizerImpl struct {
	// contains filtered or unexported fields
}

func NewOptimizerImpl

func NewOptimizerImpl(pluginOptions *proto.PluginOptions) *OptimizerImpl

func (*OptimizerImpl) Optimize

func (o *OptimizerImpl) Optimize(registry *jsonschema.Registry, entrypointMessage pgs.Message)

type SerializerImpl

type SerializerImpl struct {
	// contains filtered or unexported fields
}

func NewSerializerImpl

func NewSerializerImpl(pluginOptions *proto.PluginOptions) *SerializerImpl

func (*SerializerImpl) Serialize

func (s *SerializerImpl) Serialize(schema any, file pgs.File) ([]byte, error)

func (*SerializerImpl) ToFileName

func (s *SerializerImpl) ToFileName(file pgs.File) string

type WellKnownFieldType

type WellKnownFieldType int

const (
	WellKnownTypeNone WellKnownFieldType = iota
	WellKnownTypeTimestamp
	WellKnownTypeDuration
	WellKnownTypeAny
	WellKnownTypeNullValue
	WellKnownTypeStruct
	WellKnownTypeListValue
	WellKnownTypeValue
)

type WellKnownMessageType

type WellKnownMessageType int

const (
	WellKnownMessageTypeNone WellKnownMessageType = iota
	WellKnownMessageTypeK8sIntOrString
	WellKnownMessageTypeK8sVolume
	WellKnownMessageTypeK8sSecretProjection
	WellKnownMessageTypeK8sConfigMapVolumeSource
	WellKnownMessageTypeK8sConfigMapProjection
	WellKnownMessageTypeK8sConfigMapKeySelector
	WellKnownMessageTypeK8sSecretKeySelector
	WellKnownMessageTypeK8sConfigMapEnvSource
	WellKnownMessageTypeK8sSecretEnvSource
	WellKnownMessageTypeK8sProbe
	WellKnownMessageTypeK8sEphemeralContainer
)