naming_hint

Documentation

Index

• type NamingConstraints
• type Translator
  • func NewNameHintTranslator(constraints *NamingConstraints) (Translator, error)
• type UniqueGenerator
  • func NewUniqueNameGenerator(logger hclog.Logger, prefix string, constraints *NamingConstraints) (UniqueGenerator, error)

Types

type NamingConstraints

type NamingConstraints struct {
	LowerCaseLetters  bool
	UpperCaseLetters  bool
	Numbers           bool
	SpecialCharacters string
	MaxLength         uint
}

type Translator

type Translator interface {
	Translate(input string) (string, error)
}

func NewNameHintTranslator

func NewNameHintTranslator(constraints *NamingConstraints) (Translator, error)

type UniqueGenerator

type UniqueGenerator interface {

	// Generate create unique and consistent name that can be used in the target data source to create access elements.
	// The argument ap is an access provider pointer. Each next ap that is provided to the class should have an ascending ID to guarantee a deterministic ID generation
	// The output is a map that will point AccessIDs to the unique generate name
	Generate(ap *sync_to_target.AccessProvider) (map[string]string, error)
	GenerateOrdered(ap *sync_to_target.AccessProvider) ([]string, error)
}

func NewUniqueNameGenerator

func NewUniqueNameGenerator(logger hclog.Logger, prefix string, constraints *NamingConstraints) (UniqueGenerator, error)

NewUniqueNameGenerator will create an implementation of the UniqueGenerator interface. The UniqueGenerator will ensure the constraints provided in the first argument