4.7.4.7. Wizards

Parser for query wizards.

class axonius_api_client.parsers.wizards.WizardParser(apiobj)

Bases: object

Wizard value parsers for the various field types.

__init__(apiobj)

Parse for the various field types.

:param apiobj axonius_api_client.api.assets.asset_mixin.AssetMixin: Asset object to

use when validating fields/adapters/connection labels/etc.

apiobj

Asset object to use when validating fields/adapters/connection labels/etc.

Type

axonius_api_client.api.assets.asset_mixin.AssetMixin

__call__(value, parser, enum=None, enum_items=None)

Parse a value and return the AQL and raw expression values.

Parameters

• value (typing.Any) – value to parse/validate as valid enum

• parser (str) – parser from field type to use

• enum (typing.Optional[typing.List[str]]) – valid values allowed for the field this value is intended for

• enum_items (typing.Optional[typing.List[str]]) – more valid values allowed for the field this value is intended for

Return type

typing.Tuple[str, typing.Any]

Returns

AQL value and raw expression value

value_to_csv_adapters(value, enum=None, enum_items=None)

Parse a value as a comma separated list of valid adapter names.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_cnx_label(value, enum=None, enum_items=None)

Parse a value as a comma separated list of valid connection labels.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_int(value, enum=None, enum_items=None)

Parse a value as a comma separated list of integers.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_ip(value, enum=None, enum_items=None)

Parse a value as a comma separated list of IP addresses.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_str(value, enum=None, enum_items=None)

Parse a value as a comma separated list of strings.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_subnet(value, enum=None, enum_items=None)

Parse a value as a comma separated list of subnets.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_tags(value, enum=None, enum_items=None)

Parse a value as a comma separated list of valid asset tags (labels).

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_csv_tags_expirable(value, enum=None, enum_items=None)

Parse a value as a comma separated list of valid asset tags (labels).

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_dt(value, enum=None, enum_items=None)

Parse a value as a datetime string.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_in_subnet(value, enum=None, enum_items=None)

Parse a value into the start and end of a subnet.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[typing.List[str], str]

value_to_int(value, enum=None, enum_items=None)

Parse a value as an integer.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, typing.Union[int, float]]

value_to_ip(value, enum=None, enum_items=None)

Parse a value as an IP address.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_none(value, enum=None, enum_items=None)

Parse a value as none.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, None]

value_to_raw_version(value, enum=None, enum_items=None)

Parse a value as a raw version string.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str(value, enum=None, enum_items=None)

Parse a value as a string.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_adapters(value, enum=None, enum_items=None)

Parse a value as a valid adapter name.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_sq(value, enum=None, enum_items=None)

Parse a value as a valid name or UUID of Saved Query.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_data_scope(value, enum=None, enum_items=None)

Parse a value as a valid name or UUID of a Data Scope.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_cnx_label(value, enum=None, enum_items=None)

Parse a value as a valid connection label.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_escaped_regex(value, enum=None, enum_items=None)

Parse a value as an escaped regular expression.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_tags(value, enum=None, enum_items=None)

Parse a value as a valid asset tag (label).

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_tags_expirable(value, enum=None, enum_items=None)

Parse a value as a valid asset tag (label).

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

value_to_str_subnet(value, enum=None, enum_items=None)

Parse a value as a subnet.

Parameters

• value (typing.Any) –

• enum (typing.Optional[typing.List[str]]) –

• enum_items (typing.Optional[typing.List[str]]) –

Return type

typing.Tuple[str, str]

parse_csv(value, converter=None, join_tmpl='"{}"', enum=None, enum_items=None, enum_callback=None)

Parse a comma separated string.

Parameters

• value (typing.Any) – string to split

• converter (typing.Optional[typing.Any]) – method to convert each item after split

• join_tmpl (str) – template to use when joining the values for the SQL value

• enum (typing.Optional[typing.List[str]]) – valid values allowed for the field this value is intended for

• enum_items (typing.Optional[typing.List[str]]) – more valid values allowed for the field this value is intended for

• enum_callback (typing.Optional[typing.Callable]) – custom values allowed for the field this value is intended for

Return type

typing.Tuple[str, str]

check_enum(value, enum=None, enum_items=None, enum_callback=None)

Check that the value is a valid option of enums.

Parameters

• value (typing.Union[int, str]) – value to check

• enum (typing.Optional[typing.List[typing.Union[str, int, float]]]) – valid values allowed for the field this value is intended for

• enum_items (typing.Optional[typing.List[typing.Union[str, int, float]]]) – more valid values allowed for the field this value is intended for

• enum_callback (typing.Optional[typing.Callable]) – custom values allowed for the field this value is intended for

Return type

typing.Union[int, str]

enum_cb_sq(value)

Pass.

Parameters

value (typing.Any) –

Return type

str

enum_cb_cnx_label(value)

Pass.

Parameters

value (typing.Any) –

Return type

str

enum_cb_asset_tags(value)

Pass.

Parameters

value (typing.Any) –

Return type

str

enum_cb_asset_tags_expirable(value)

Pass.

Parameters

value (typing.Any) –

Return type

str

enum_cb_adapter_name(value)

Pass.

Parameters

value (typing.Any) –

Return type

str

enum_cb_data_scope(value)

Pass.

Parameters

value (typing.Any) –

Return type

str

get_adapters()

Get all known adapters.

Return type

typing.List[dict]

get_cnx_labels()

Get all known adapter connection labels.

Return type

typing.List[dict]

get_instances()

Get all known instances/nodes.

Return type

typing.List[object]

get_sqs()

Get all Saved Query objects for this asset type.

Return type

typing.List[object]

get_asset_tags()

Get all known tags (labels) of this asset type.

Return type

typing.List[str]

get_asset_tags_expirable()

Get all known expirable tags (labels) of this asset type.

Return type

typing.List[str]