indicator

Documentation

Index

• func ApiVersionFromYAML(docBytes []byte) (string, error)
• func ApplyPatches(patches []Patch, documentBytes []byte) ([]byte, error)
• func DocumentFromYAML(r io.ReadCloser, opts ...ReadOpt) (v1.IndicatorDocument, []error)
• func KindFromYAML(fileBytes []byte) (string, error)
• func MatchDocument(patch Patch, documentBytes []byte) bool
• func MetadataFromYAML(reader io.ReadCloser) (map[string]string, error)
• func OverrideMetadata(overrideMetadata map[string]string) func(options *readOptions)
• func ParseMetadata(input string) map[string]string
• func ProcessDocument(patches []Patch, documentBytes []byte) (v1.IndicatorDocument, []error)
• func ProductFromYAML(reader io.ReadCloser) (v1.Product, error)
• func ReadFile(indicatorsFile string, opts ...ReadOpt) (IndicatorDocument, error)
• func SkipMetadataInterpolation(options *readOptions)
• type Match
• type Patch
  • func PatchFromYAML(reader io.ReadCloser) (Patch, error)
  • func ReadPatchFile(patchFile string) (Patch, error)
• type ReadOpt

Functions

func ApiVersionFromYAML

func ApiVersionFromYAML(docBytes []byte) (string, error)

func ApplyPatches

func ApplyPatches(patches []Patch, documentBytes []byte) ([]byte, error)

func DocumentFromYAML

func DocumentFromYAML(r io.ReadCloser, opts ...ReadOpt) (v1.IndicatorDocument, []error)

func KindFromYAML

func KindFromYAML(fileBytes []byte) (string, error)

func MatchDocument

func MatchDocument(patch Patch, documentBytes []byte) bool

func MetadataFromYAML

func MetadataFromYAML(reader io.ReadCloser) (map[string]string, error)

func OverrideMetadata

func OverrideMetadata(overrideMetadata map[string]string) func(options *readOptions)

func ParseMetadata

func ParseMetadata(input string) map[string]string

func ProcessDocument

func ProcessDocument(patches []Patch, documentBytes []byte) (v1.IndicatorDocument, []error)

func ProductFromYAML

func ProductFromYAML(reader io.ReadCloser) (v1.Product, error)

func ReadFile

func ReadFile(indicatorsFile string, opts ...ReadOpt) (IndicatorDocument, error)

Reads the IndicatorDocument in the file with the given name, Returns an error if the file can't be read, or the file isn't valid YAML parsable as a document, or the document can't be validated.

func SkipMetadataInterpolation

func SkipMetadataInterpolation(options *readOptions)

Types

type Match

type Match struct {
	Name     *string
	Version  *string
	Metadata map[string]string
}

type Patch

type Patch struct {
	APIVersion string
	Match      Match
	Operations []patch.OpDefinition
}

func PatchFromYAML

func PatchFromYAML(reader io.ReadCloser) (Patch, error)

func ReadPatchFile

func ReadPatchFile(patchFile string) (Patch, error)

type ReadOpt

type ReadOpt func(options *readOptions)