Skip to main content

Textquery

Query parameters used to construct an Elasticsearch text query object.

Properties

NameTypeDescriptionNotes
terms[]strWords or characters that specify a particular thing to be searched for.[required]
fields[]strThe fields to be searched.[required]
match_anyboolIndicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found.[optional] [default to False]
containsboolIndicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms.[optional] [default to False]
}

Example

from sailpoint.search.models.textquery import Textquery

textquery = Textquery(
terms=["The quick brown fox","3141592","7"],
fields=["displayName","employeeNumber","roleCount"],
match_any=False,
contains=True
)

[Back to top]