ucsschool.kelvin.client.base module

class ucsschool.kelvin.client.base.KelvinObject(*, name: str = None, ucsschool_roles: List[str] = None, udm_properties: Dict[str, Any] = None, dn: str = None, url: str = None, session: ucsschool.kelvin.client.session.Session = None, language: str = None, **kwargs)[source]

Bases: abc.ABC

as_dict() → Dict[str, Any][source]
delete() → None[source]
reload() → KelvinObjectType[source]

Reload properties of object from the Kelvin API.

Raises:ucsschool.kelvin.client.NoObject – if the object cannot be found
save() → KelvinObjectType[source]
class ucsschool.kelvin.client.base.KelvinResource(session: ucsschool.kelvin.client.session.Session, language: str = None)[source]

Bases: abc.ABC

class Meta[source]

Bases: object


alias of KelvinObject

required_get_attrs = ('name',)
required_head_attrs = ('name',)
required_search_attrs = ('school',)
exists(**kwargs) → bool[source]
get(**kwargs) → KelvinObjectType[source]
get_from_url(url: str) → KelvinObjectType[source]
search(**kwargs) → AsyncIterator[KelvinObjectType][source]