heat.objects.base module

Heat common internal object model

class heat.objects.base.HeatObject(context: Any = None, **kwargs: Any)[source]

Bases: VersionedObject

OBJ_PROJECT_NAMESPACE: str = 'heat'

Object project namespace for serialization

This is used to disambiguate owners of objects sharing a common RPC medium.

VERSION: str = '1.0'

Object version field

Each service has its set of objects, each with a version attached. When a client attempts to call an object method, the server checks to see if the version of that object matches (in a compatible way) its object implementation. If so, cool, and if not, fail.

This version is allowed to have three parts, X.Y.Z, where the .Z element is reserved for stable branch backports. The .Z is ignored for the purposes of triggering a backport, which means anything changed under a .Z must be additive and non-destructive such that a node that knows about X.Y can consider X.Y.Z equivalent.

class heat.objects.base.HeatObjectRegistry(*args: Any, **kwargs: Any)[source]

Bases: VersionedObjectRegistry