domain

Documentation

Overview

Package domain defines core business types and category enums for the toolkit application.

Index

• Variables
• func GetInitials(s string) string
• type Category
  • func ParseCategory(s string) (Category, error)
  • func (e Category) Definition() Category
  • func (e Category) GetAliases() []string
  • func (e Category) GetFilterableFields() []string
  • func (e Category) GetName() string
  • func (e Category) IsFaulty() bool
  • func (e Category) IsScope() bool
  • func (e Category) IsScopeOf(o Category) bool
  • func (e Category) ScopedCategories() []Category
  • func (i Category) String() string
• type ToolkitContext

Variables

var (
	Aliases    []string
	Categories []Category
)

var ErrUnknownCategory = errors.New("unknown category")

ErrUnknownCategory is returned when a string cannot be parsed into a known Category.

Functions

func GetInitials

func GetInitials(s string) string

Types

type Category

type Category int

Category represents a logical grouping for toolkit data.

const (
	// CategoryUnknown is the zero value for Category.
	CategoryUnknown Category = iota

	// Tenant is a category for tenant-level data.
	Tenant
	// LimitDefinition is a category for limit definitions.
	LimitDefinition
	// ConsolePropertyDefinition is a category for console property definitions.
	ConsolePropertyDefinition
	// PropertyDefinition is a category for property definitions.
	PropertyDefinition
	// LimitTenancyOverride is a category for limit tenancy overrides.
	LimitTenancyOverride
	// ConsolePropertyTenancyOverride is a category for console property tenancy overrides.
	ConsolePropertyTenancyOverride
	// PropertyTenancyOverride is a category for property tenancy overrides.
	PropertyTenancyOverride
	// LimitRegionalOverride is a category for limit regional overrides.
	LimitRegionalOverride
	// ConsolePropertyRegionalOverride is a category for console property regional overrides.
	ConsolePropertyRegionalOverride
	// PropertyRegionalOverride is a category for property regional overrides.
	PropertyRegionalOverride
	// BaseModel is a category for base models.
	BaseModel
	// ModelArtifact is a category for model artifacts.
	ModelArtifact
	// Environment is a category for environments.
	Environment
	// ServiceTenancy is a category for service tenancies.
	ServiceTenancy
	// GpuPool is a category for GPU pools.
	GpuPool
	// GpuNode is a category for GPU nodes.
	GpuNode
	// DedicatedAICluster is a category for dedicated AI clusters.
	DedicatedAICluster
	// Alias is a category for reporting all aliases.
	Alias
)

func ParseCategory

func ParseCategory(s string) (Category, error)

ParseCategory parses a string (case-insensitive, with common aliases) into a Category enum.

func (Category) Definition

func (e Category) Definition() Category

Definition returns the definition category for the receiver.

func (Category) GetAliases

func (e Category) GetAliases() []string

func (Category) GetFilterableFields

func (e Category) GetFilterableFields() []string

func (Category) GetName

func (e Category) GetName() string

func (Category) IsFaulty

func (e Category) IsFaulty() bool

func (Category) IsScope

func (e Category) IsScope() bool

IsScope returns true if the category is a scope category.

func (Category) IsScopeOf

func (e Category) IsScopeOf(o Category) bool

IsScopeOf returns true if the receiver is a scope of the given category.

func (Category) ScopedCategories

func (e Category) ScopedCategories() []Category

ScopedCategories returns the categories that are scoped by the receiver.

func (Category) String

func (i Category) String() string

type ToolkitContext

type ToolkitContext struct {
	Category Category
	Name     string
}

ToolkitContext holds the current scope and name for filtering or scoping operations.