NodeNameFilterBuilder

Methods

MethodDescription
containsReturns a filter expression that checks whether the entity's
ends_withReturns a filter expression that checks whether the entity's
fuzzy_searchReturns a filter expression that performs fuzzy matching
is_inReturns a filter expression that checks whether the entity's
is_not_inReturns a filter expression that checks whether the entity's
not_containsReturns a filter expression that checks whether the entity's
starts_withReturns a filter expression that checks whether the entity's

Method Details

contains

Signature: contains(value)

Returns a filter expression that checks whether the entity's string value contains the given substring.

Parameters

NameTypeDefaultDescription
valuestr-Substring that must appear within the value.

Returns

TypeDescription
filter.FilterExprA filter expression evaluating substring search.

ends_with

Signature: ends_with(value)

Returns a filter expression that checks whether the entity's string value ends with the specified suffix.

Parameters

NameTypeDefaultDescription
valuestr-Suffix to check for.

Returns

TypeDescription
filter.FilterExprA filter expression evaluating suffix matching.

Signature: fuzzy_search(value, levenshtein_distance, prefix_match)

Returns a filter expression that performs fuzzy matching against the entity's string value.

Uses a specified Levenshtein distance and optional prefix matching.

Parameters

NameTypeDefaultDescription
valuestr-String to approximately match against.
levenshtein_distanceint-Maximum allowed edit distance.
prefix_matchbool-If true, the value must also match as a prefix.

Returns

TypeDescription
filter.FilterExprA filter expression performing approximate text matching.

is_in

Signature: is_in(values)

Returns a filter expression that checks whether the entity's string value is contained within the given iterable of strings.

Parameters

NameTypeDefaultDescription
valueslist[str]-Iterable of allowed string values.

Returns

TypeDescription
filter.FilterExprA filter expression evaluating membership.

is_not_in

Signature: is_not_in(values)

Returns a filter expression that checks whether the entity's string value is not contained within the given iterable of strings.

Parameters

NameTypeDefaultDescription
valueslist[str]-Iterable of string values to exclude.

Returns

TypeDescription
filter.FilterExprA filter expression evaluating non-membership.

not_contains

Signature: not_contains(value)

Returns a filter expression that checks whether the entity's string value does not contain the given substring.

Parameters

NameTypeDefaultDescription
valuestr-Substring that must not appear within the value.

Returns

TypeDescription
filter.FilterExprA filter expression evaluating substring exclusion.

starts_with

Signature: starts_with(value)

Returns a filter expression that checks whether the entity's string value starts with the specified prefix.

Parameters

NameTypeDefaultDescription
valuestr-Prefix to check for.

Returns

TypeDescription
filter.FilterExprA filter expression evaluating prefix matching.