4.7.5.1. Data classes

Base classes for data types.

class axonius_api_client.data.BaseEnum(value)

Bases: Enum

Base class for enums.

_enums(lower=True)

Pass.

Parameters:

lower (bool) –

Return type:

typing.List[typing.Any]

value_matches(value, lower=True)

Pass.

Parameters:

• value (typing.Any) –

• lower (bool) –

Return type:

bool

classmethod get_value(value)

Pass.

Parameters:

value (typing.Union[axonius_api_client.data.BaseEnum, str]) –

Return type:

axonius_api_client.data.BaseEnum

classmethod get_obj_by_value(value, match_name=True, match_value=True, match_obj=True)

Pass.

Parameters:

• value (typing.Any) –

• match_name (bool) –

• match_value (bool) –

• match_obj (bool) –

Return type:

axonius_api_client.data.BaseEnum

classmethod get_name_by_value(value, **kwargs)

Pass.

Parameters:

value (typing.Any) –

Return type:

str

classmethod get_value_by_value(value, **kwargs)

Pass.

Parameters:

value (typing.Any) –

Return type:

str

classmethod keys()

Pass.

Return type:

typing.List[str]

classmethod values()

Pass.

Return type:

typing.List[str]

classmethod to_dict()

Pass.

Return type:

dict

class axonius_api_client.data.BaseData

Bases: object

Base class for dataclasses.

to_dict()

Get this dataclass object as a dictionary.

Return type:

dict

replace(**kwargs)

Pass.

Return type:

axonius_api_client.data.BaseData

static _human_key(key)

Pass.

classmethod get_fields()

Get a list of fields defined for current this dataclass object.

Return type:

typing.List[dataclasses.Field]

class axonius_api_client.data.PropsData

Bases: BaseData

Pass.

raw: dict

__str__()

Pass.

__repr__()

Pass.

to_str_properties()

Pass.

Return type:

typing.List[str]

to_dict(dt_obj=False)

Pass.

Parameters:

dt_obj (bool) –

Return type:

dict

static _human_key(key)

Pass.

classmethod get_fields()

Get a list of fields defined for current this dataclass object.

Return type:

typing.List[dataclasses.Field]

replace(**kwargs)

Pass.

Return type:

axonius_api_client.data.BaseData