Documentation
¶
Overview ¶
Package models contains PUBLIC aliases for database models and related types.
NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.
Package models contains PUBLIC aliases for database models and related types.
NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.
Package models contains PUBLIC aliases for database models and related types.
NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.
Package models contains PUBLIC aliases for database models and related types.
NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.
Package models contains PUBLIC aliases for database models and related types.
NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.
Package models contains PUBLIC aliases for database models and related types.
NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.
Index ¶
Constants ¶
const (
AdminID = internalmodels.AdminID
)
Constants related to users
Variables ¶
var (
ValidateOwnerID = internalmodels.ValidateOwnerID
)
Functions related to users (public aliases)
Functions ¶
This section is empty.
Types ¶
type Instance ¶
type Instance = internalmodels.Instance
Instance represents a compute instance in the system (public alias)
type InstanceStatus ¶
type InstanceStatus = internalmodels.InstanceStatus
InstanceStatus represents the current state of an instance
const ( InstanceStatusUnknown InstanceStatus = internalmodels.InstanceStatusUnknown InstanceStatusPending InstanceStatus = internalmodels.InstanceStatusPending InstanceStatusCreated InstanceStatus = internalmodels.InstanceStatusCreated InstanceStatusProvisioning InstanceStatus = internalmodels.InstanceStatusProvisioning InstanceStatusReady InstanceStatus = internalmodels.InstanceStatusReady InstanceStatusTerminated InstanceStatus = internalmodels.InstanceStatusTerminated )
Instance status constants
type ListOptions ¶
type ListOptions = internalmodels.ListOptions
ListOptions represents pagination and filtering options for list operations
type PayloadStatus ¶
type PayloadStatus = internalmodels.PayloadStatus
PayloadStatus represents the state of a payload operation on an instance
const ( PayloadStatusNone PayloadStatus = internalmodels.PayloadStatusNone PayloadStatusPendingCopy PayloadStatus = internalmodels.PayloadStatusPendingCopy PayloadStatusCopyFailed PayloadStatus = internalmodels.PayloadStatusCopyFailed PayloadStatusCopied PayloadStatus = internalmodels.PayloadStatusCopied PayloadStatusPendingExecution PayloadStatus = internalmodels.PayloadStatusPendingExecution PayloadStatusExecutionFailed PayloadStatus = internalmodels.PayloadStatusExecutionFailed PayloadStatusExecuted PayloadStatus = internalmodels.PayloadStatusExecuted )
Payload status constants
type Project ¶
type Project = internalmodels.Project
Project represents a project in the system (public alias).
type ProviderID ¶
type ProviderID = internalmodels.ProviderID
ProviderID represents a compute provider
const ( ProviderAWS ProviderID = internalmodels.ProviderAWS ProviderGCP ProviderID = internalmodels.ProviderGCP ProviderAzure ProviderID = internalmodels.ProviderAzure ProviderDO ProviderID = internalmodels.ProviderDO ProviderScaleway ProviderID = internalmodels.ProviderScaleway ProviderVultr ProviderID = internalmodels.ProviderVultr ProviderLinode ProviderID = internalmodels.ProviderLinode ProviderHetzner ProviderID = internalmodels.ProviderHetzner ProviderOVH ProviderID = internalmodels.ProviderOVH // Mock Providers ProviderDOMock1 ProviderID = internalmodels.ProviderDOMock1 ProviderDOMock2 ProviderID = internalmodels.ProviderDOMock2 ProviderMock3 ProviderID = internalmodels.ProviderMock3 )
Provider constants
type StatusFilter ¶
type StatusFilter = internalmodels.StatusFilter
StatusFilter represents how to filter db items by status
const ( // StatusFilterEqual indicates filtering for instances with matching status StatusFilterEqual StatusFilter = internalmodels.StatusFilterEqual // StatusFilterNotEqual indicates filtering for instances with non-matching status StatusFilterNotEqual StatusFilter = internalmodels.StatusFilterNotEqual )
type Task ¶
type Task = internalmodels.Task
Task represents a background task in the system (public alias).
type TaskAction ¶
type TaskAction = internalmodels.TaskAction
TaskAction defines the type of action a task performs.
const ( // TaskActionUnknown TaskAction = internalmodels.TaskActionUnknown // REMOVED - Not defined internally TaskActionCreateInstances TaskAction = internalmodels.TaskActionCreateInstances TaskActionTerminateInstances TaskAction = internalmodels.TaskActionTerminateInstances TaskActionDeleteUpload TaskAction = internalmodels.TaskActionDeleteUpload )
Task action constants.
type TaskStatus ¶
type TaskStatus = internalmodels.TaskStatus
TaskStatus represents the status of a task.
const ( TaskStatusUnknown TaskStatus = internalmodels.TaskStatusUnknown TaskStatusPending TaskStatus = internalmodels.TaskStatusPending TaskStatusRunning TaskStatus = internalmodels.TaskStatusRunning TaskStatusCompleted TaskStatus = internalmodels.TaskStatusCompleted TaskStatusFailed TaskStatus = internalmodels.TaskStatusFailed TaskStatusTerminated TaskStatus = internalmodels.TaskStatusTerminated )
Task status constants.
type UserQueryOptions ¶
type UserQueryOptions = internalmodels.UserQueryOptions
UserQueryOptions represents query params for GetUserByUsername operation
type UserRole ¶
type UserRole = internalmodels.UserRole
UserRole represents the role of a user
const ( UserRoleUser UserRole = internalmodels.UserRoleUser UserRoleAdmin UserRole = internalmodels.UserRoleAdmin )
User role constants
type VolumeDetail ¶
type VolumeDetail = internalmodels.VolumeDetail
VolumeDetail represents a block storage volume (public alias)
type VolumeDetails ¶
type VolumeDetails = internalmodels.VolumeDetails
VolumeDetails represents the details of a volume (public alias)