Documentation
¶
Overview ¶
Package appyamlkit is used to interpret AppConfig/YAML configuration units.
Index ¶
- Constants
- Variables
- type AppConfigYAMLResourceProviderType
- func (*AppConfigYAMLResourceProviderType) ContextPath(contextField string) string
- func (*AppConfigYAMLResourceProviderType) DataType() api.DataType
- func (*AppConfigYAMLResourceProviderType) DefaultResourceCategory() api.ResourceCategory
- func (*AppConfigYAMLResourceProviderType) GetPathRegistry() api.AttributeNameToResourceTypeToPathToVisitorInfoType
- func (*AppConfigYAMLResourceProviderType) NameSeparator() string
- func (*AppConfigYAMLResourceProviderType) NativeToYAML(data []byte) ([]byte, error)
- func (*AppConfigYAMLResourceProviderType) NormalizeName(name string) string
- func (c *AppConfigYAMLResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName
- func (*AppConfigYAMLResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, ...)
- func (*AppConfigYAMLResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)
- func (*AppConfigYAMLResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
- func (*AppConfigYAMLResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)
- func (*AppConfigYAMLResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool
- func (*AppConfigYAMLResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath
- func (*AppConfigYAMLResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error
- func (*AppConfigYAMLResourceProviderType) TypeDescription() string
- func (*AppConfigYAMLResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)
Constants ¶
View Source
const ( ResourceTypeNoSchema = api.ResourceType("NoSchema") ResourceNameNoName = api.ResourceName("NoName") ConfigSchemaPath = api.ResolvedPath("configHub.configSchema") ConfigNamePath = api.ResolvedPath("configHub.configName") )
Variables ¶
View Source
var AppConfigYAMLNonSpaceScopedEntityTypes = map[api.ResourceType]bool{}
View Source
var AppConfigYAMLResourceProvider = &AppConfigYAMLResourceProviderType{}
AppConfigYAMLResourceProvider implements the ResourceProvider interface for AppConfig/YAML.
Functions ¶
This section is empty.
Types ¶
type AppConfigYAMLResourceProviderType ¶
type AppConfigYAMLResourceProviderType struct{}
func (*AppConfigYAMLResourceProviderType) ContextPath ¶
func (*AppConfigYAMLResourceProviderType) ContextPath(contextField string) string
func (*AppConfigYAMLResourceProviderType) DataType ¶
func (*AppConfigYAMLResourceProviderType) DataType() api.DataType
func (*AppConfigYAMLResourceProviderType) DefaultResourceCategory ¶
func (*AppConfigYAMLResourceProviderType) DefaultResourceCategory() api.ResourceCategory
DefaultResourceCategory returns the default resource category to asssume, which is AppConfig in this case.
func (*AppConfigYAMLResourceProviderType) GetPathRegistry ¶
func (*AppConfigYAMLResourceProviderType) GetPathRegistry() api.AttributeNameToResourceTypeToPathToVisitorInfoType
func (*AppConfigYAMLResourceProviderType) NameSeparator ¶
func (*AppConfigYAMLResourceProviderType) NameSeparator() string
func (*AppConfigYAMLResourceProviderType) NativeToYAML ¶
func (*AppConfigYAMLResourceProviderType) NativeToYAML(data []byte) ([]byte, error)
func (*AppConfigYAMLResourceProviderType) NormalizeName ¶
func (*AppConfigYAMLResourceProviderType) NormalizeName(name string) string
func (*AppConfigYAMLResourceProviderType) RemoveScopeFromResourceName ¶
func (c *AppConfigYAMLResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName
func (*AppConfigYAMLResourceProviderType) ResourceAndCategoryTypeMaps ¶
func (*AppConfigYAMLResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, categoryTypeMap yamlkit.ResourceCategoryTypeToNamesMap, err error)
ResourceAndCategoryTypeMaps returns maps of all resources in the provided list of parsed YAML documents, from from names to categories+types and categories+types to names.
func (*AppConfigYAMLResourceProviderType) ResourceCategoryGetter ¶
func (*AppConfigYAMLResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)
ResourceCategoryGetter just returns ResourceCategoryAppConfig for AppConfigYAML documents.
func (*AppConfigYAMLResourceProviderType) ResourceNameGetter ¶
func (*AppConfigYAMLResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)
ResourceNameGetter extracts the property Slug, and returns NoName if not present.
func (*AppConfigYAMLResourceProviderType) ResourceTypeGetter ¶
func (*AppConfigYAMLResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)
ResourceTypeGetter extracts the property EntityType, and returns NoEntityType if not present.
func (*AppConfigYAMLResourceProviderType) ResourceTypesAreSimilar ¶
func (*AppConfigYAMLResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool
func (*AppConfigYAMLResourceProviderType) ScopelessResourceNamePath ¶
func (*AppConfigYAMLResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath
func (*AppConfigYAMLResourceProviderType) SetResourceName ¶
func (*AppConfigYAMLResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error
func (*AppConfigYAMLResourceProviderType) TypeDescription ¶
func (*AppConfigYAMLResourceProviderType) TypeDescription() string
func (*AppConfigYAMLResourceProviderType) YAMLToNative ¶
func (*AppConfigYAMLResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)
Source Files
Click to show internal directories.
Click to hide internal directories.