module

Documentation

Index

• type Module
• type ModuleImport
  • func NewModuleImport(alias, importPath string) (*ModuleImport, error)

Types

type Module

type Module interface {
	Initialize() error
	Name() string
	Apply() *types.Result
	Destroy() *types.Result
}

type ModuleImport

type ModuleImport struct {
	// Alias is the name given to an import in a playbook's imports map.
	// It is the key in the map for an import, and the name that playbook
	// tasks use to refer to a module.
	Alias string
	// GoImportPath is a valid Go import for the package containing a module.
	GoImportPath string
	// QualifiedIdentifier is the dot-separated package and module name.
	QualifiedIdentifier string
}

func NewModuleImport

func NewModuleImport(alias, importPath string) (*ModuleImport, error)

NewModuleImport returns a `*ModuleImport` for the given alias and import path. The import path is the import path as used in a playbook and is not a valid Go import path, as it has the module appended as a suffix.