Documentation
¶
Index ¶
- func GolangNameTitle(name string) string
- func MetadataFiles(sourceDirectory string) ([]string, error)
- func ProcessMetaFiles(metadataFiles []string, targetDir string, stepHelperData StepHelperData) error
- type ContextDefaultData
- type ContextDefaultMetadata
- type ContextDefaultParameters
- type InfluxMeasurement
- type InfluxMetric
- type InfluxMetricContent
- type InfluxResource
- type PiperEnvironmentParameter
- type PiperEnvironmentResource
- type ReportsParameter
- type ReportsResource
- type StepHelperData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GolangNameTitle ¶ added in v1.186.0
GolangNameTitle returns name in title case with abbriviations in capital (API, URL, ID, JSON, TLS)
func MetadataFiles ¶
MetadataFiles provides a list of all step metadata files
func ProcessMetaFiles ¶
func ProcessMetaFiles(metadataFiles []string, targetDir string, stepHelperData StepHelperData) error
ProcessMetaFiles generates step coding based on step configuration provided in yaml files
Types ¶
type ContextDefaultData ¶ added in v1.1.0
type ContextDefaultData struct {
Metadata ContextDefaultMetadata `json:"metadata"`
Parameters []ContextDefaultParameters `json:"params"`
}
ContextDefaultData holds the meta data and the default data for the context default parameter descriptions
type ContextDefaultMetadata ¶ added in v1.1.0
type ContextDefaultMetadata struct {
Name string `json:"name"`
Description string `json:"description"`
LongDescription string `json:"longDescription,omitempty"`
}
ContextDefaultMetadata holds meta data for the context default parameter descripten (name, description, long description)
type ContextDefaultParameters ¶ added in v1.1.0
type ContextDefaultParameters struct {
Name string `json:"name"`
Description string `json:"description"`
Scope []string `json:"scope"`
}
ContextDefaultParameters holds the description for the context default parameters
type InfluxMeasurement ¶ added in v1.9.0
type InfluxMeasurement struct {
Name string
Fields []InfluxMetric
Tags []InfluxMetric
}
InfluxMeasurement defines a measurement for Influx reporting which is defined via a step resource
type InfluxMetric ¶ added in v1.9.0
InfluxMetric defines a metric (column) in an influx measurement
type InfluxMetricContent ¶ added in v1.9.0
InfluxMetricContent defines the content of an Inflx metric
type InfluxResource ¶ added in v1.9.0
type InfluxResource struct {
Name string
StepName string
Measurements []InfluxMeasurement
}
InfluxResource defines an Influx resouece that holds measurement information for a pipeline run
func (*InfluxResource) StructName ¶ added in v1.9.0
func (i *InfluxResource) StructName() string
StructName returns the name of the influx resource struct
func (*InfluxResource) StructString ¶ added in v1.9.0
func (i *InfluxResource) StructString() (string, error)
StructString returns the golang coding for the struct definition of the InfluxResource
type PiperEnvironmentParameter ¶ added in v1.9.0
PiperEnvironmentParameter defines a parameter within the Piper environment
type PiperEnvironmentResource ¶ added in v1.9.0
type PiperEnvironmentResource struct {
Name string
StepName string
Parameters []PiperEnvironmentParameter
Categories []string
}
PiperEnvironmentResource defines a piper environement resource which stores data across multiple pipeline steps
func (*PiperEnvironmentResource) StructName ¶ added in v1.9.0
func (p *PiperEnvironmentResource) StructName() string
StructName returns the name of the environment resource struct
func (*PiperEnvironmentResource) StructString ¶ added in v1.9.0
func (p *PiperEnvironmentResource) StructString() (string, error)
StructString returns the golang coding for the struct definition of the environment resource
type ReportsParameter ¶ added in v1.186.0
PiperEnvironmentParameter defines a parameter within the Piper environment
type ReportsResource ¶ added in v1.186.0
type ReportsResource struct {
Name string
StepName string
Parameters []ReportsParameter
}
PiperEnvironmentResource defines a piper environement resource which stores data across multiple pipeline steps
func (*ReportsResource) StructName ¶ added in v1.186.0
func (p *ReportsResource) StructName() string
StructName returns the name of the environment resource struct
func (*ReportsResource) StructString ¶ added in v1.186.0
func (p *ReportsResource) StructString() (string, error)
StructString returns the golang coding for the struct definition of the environment resource
type StepHelperData ¶ added in v1.1.0
type StepHelperData struct {
OpenFile func(s string) (io.ReadCloser, error)
WriteFile func(filename string, data []byte, perm os.FileMode) error
ExportPrefix string
}
StepHelperData is used to transport the needed parameters and functions from the step generator to the step generation.