4.7.4.7. Wizards¶
Parser for query wizards.
-
class
axonius_api_client.parsers.wizards.
WizardParser
(apiobj)[source]¶ Bases:
object
Wizard value parsers for the various field types.
-
__init__
(apiobj)[source]¶ 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.
- :param apiobj
-
apiobj
¶ Asset object to use when validating fields/adapters/connection labels/etc.
-
__call__
(value, parser, enum=None, enum_items=None)[source]¶ Parse a value and return the AQL and raw expression values.
- Parameters
value (
typing.Any
) – value to parse/validate as valid enumparser (
str
) – parser from field type to useenum (
typing.Optional
[typing.List
[str
]]) – valid values allowed for the field this value is intended forenum_items (
typing.Optional
[typing.List
[str
]]) – more valid values allowed for the field this value is intended for
- Return type
- Returns
AQL value and raw expression value
-
value_to_csv_adapters
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_csv_cnx_label
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_csv_int
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_csv_ip
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_csv_str
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_csv_subnet
(value, enum=None, enum_items=None)[source]¶ 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
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
-
value_to_dt
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_in_subnet
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_int
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_ip
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_none
(value, enum=None, enum_items=None)[source]¶ Parse a value as none.
- Parameters
value (
typing.Any
) –enum (
typing.Optional
[typing.List
[str
]]) –enum_items (
typing.Optional
[typing.List
[str
]]) –
- Return type
-
value_to_raw_version
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_str
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_str_adapters
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_str_cnx_label
(value, enum=None, enum_items=None)[source]¶ 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
-
value_to_str_escaped_regex
(value, enum=None, enum_items=None)[source]¶ 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
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
-
value_to_str_subnet
(value, enum=None, enum_items=None)[source]¶ 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
-
parse_csv
(value, converter=None, join_tmpl='"{}"', enum=None, enum_items=None, enum_custom=None, custom_id=None)[source]¶ Parse a comma separated string.
- Parameters
value (
typing.Any
) – string to splitconverter (
typing.Optional
[typing.Any
]) – method to convert each item after splitjoin_tmpl (
str
) – template to use when joining the values for the SQL valueenum (
typing.Optional
[typing.List
[str
]]) – valid values allowed for the field this value is intended forenum_items (
typing.Optional
[typing.List
[str
]]) – more valid values allowed for the field this value is intended forenum_custom (
typing.Optional
[typing.List
[typing.Union
[str
,int
]]]) – custom values allowed for the field this value is intended forcustom_id (
typing.Optional
[str
]) – identifier for source of enum_custom
- Return type
-
check_enum
(value, enum=None, enum_items=None, enum_custom=None, custom_id=None)[source]¶ Check that the value is a valid option of enums.
- Parameters
value (
typing.Union
[int
,str
]) – value to checkenum (
typing.Optional
[typing.List
[str
]]) – valid values allowed for the field this value is intended forenum_items (
typing.Optional
[typing.List
[str
]]) – more valid values allowed for the field this value is intended forenum_custom (
typing.Union
[typing.List
[str
],typing.Dict
[str
,str
],None
]) – custom values allowed for the field this value is intended forcustom_id (
typing.Optional
[str
]) – identifier for source of enum_custom
- Return type
Get all known tags (labels) of this asset type.
- Return type
-