Module api_objects

Module api_objects 

Source

Modulesยง

controller ๐Ÿ”’
error ๐Ÿ”’
node ๐Ÿ”’
router ๐Ÿ”’
separation_context ๐Ÿ”’
virtual_machine ๐Ÿ”’
volume ๐Ÿ”’

Structsยง

AssignedDeviceNames
AvailableVlanTags
Provides a list of unused tags that may be used by new separation contexts. Internal management data that will not be exposed to users.
Controller
ControllerStatus
DeletionMark
Indicates an on-going deletion process.
Endpoint
Finalizers
A sequence of FinalizerIds that should be processed in the right order, one by one. Deletion may performed only if there is no FinalizerId left to process.
ForwardedPort
LocalStorage
MetaData
Node
NodeStatus
ResourceVersion
Resources
Router
SclInfo
Data type for wrapping additional informational messages
SclName
Non-empty string consisting of lowercase alphanumeric characters as well as hyphens -. The name must start with a letter and must end with an alphanumeric character The length must not exceed 63. This way, SclNames can be used as DNS label names as specified in RFC 1035.
SeparationContext
TransitionInfo
Url
VirtualMachine
VlanTag
VmCondition
VmSpec
Volume

Enumsยง

BootVolume
ControllerKind
Error
The error type for interaction with the api_objects module of the scl-lib.
FinalizerId
Indicates that certain work needs to be done by controllers before an SclObject can be safely (proper shutdown, no dangling references) deleted. Since SclObjects reference parent / owner SclObjects via SclNames, the work indicated by FinalizerId mainly affects children objects of a SclObject.
NotAssignedStatus
RouterStatus
SclEvent
Common event classification
TargetVmStatus
TransitionError
ValueSpaceExhaustedError
VmStatus
VolumeStatus

Staticsยง

SCL_NAME_REGEX ๐Ÿ”’

Traitsยง

SclObject
This trait is implemented by all SCL API objects to provide uniform access to common properties of the objects.

Functionsยง

derive_volume_file_path
Returns the path where a volume file should be stored.

Type Aliasesยง

Result