HomeGuides
Try a DemoGet the Latest ReleaseSee the CHANGELOGCreate a Feature Request / Bug ReportJoin the Conversation
Guides

String

String inspectors evaluate string data.

string.contains

Evaluates if a substring exists within a string.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
valuestringValue used during inspection.Yes

Example

sub.condition.string.contains(
  settings={value: 'abc'}
)
sub.cnd.str.has({value: 'abc'})

string.starts_with

Evaluates if a string starts with (prefix) a substring.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
valuestringValue used during inspection.Yes

Example

sub.condition.string.starts_with(
  settings={value: 'abc'}
)
sub.cnd.str.prefix({value: 'abc'})

string.ends_with

Evaluates if a string ends with (suffix) a substring.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
valuestringValue used during inspection.Yes

Example

sub.condition.string.ends_with(
  settings={value: 'abc'}
)
sub.cnd.str.suffix({value: 'abc'})

string.equal_to

Evaluates if a string is equal to the target_key string value or a static string value. Priority is given to the target_key if it exists.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
valuestringValue used during inspection.Yes

Example

sub.condition.string.equal_to(
  settings={value: 'abc'}
)
sub.cnd.str.eq({value: 'abc'})

string.greater_than

Evaluates if a string is greater than the target_key string value or a static string value. Priority is given to the target_key if it exists.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
valuestringValue used during inspection.Yes

Example

sub.condition.string.greater_than(
  settings={value: 'abc'}
)
sub.cnd.str.gt({value: 'abc'})

string.less_than

Evaluates if a string is less than the target_key string value or a static string value. Priority is given to the target_key if it exists.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
valuestringValue used during inspection.Yes

Example

sub.condition.string.less_than(
  settings={value: 'abc'}
)
sub.cnd.str.lt(settings={value: 'abc'})

string.match

Evaluates if a string matches a regular expression.

Settings

FieldTypeDescriptionRequired
object.source_keystringRetrieves a value from an object for inspection.No
patternstringRegular expression pattern used during inspection.Yes

Example

sub.condition.string.match(
  settings={pattern: '^abc$'}
)
sub.cnd.str.match({pattern: '^abc$'})