flywheel.models.search_query
SearchQuery
Bases: object
all_data property writable
Gets the all_data of this SearchQuery.
When set will include all data that the user does not have access to read
Returns:
| Type | Description |
|---|---|
bool | The all_data of this SearchQuery |
filters property writable
Gets the filters of this SearchQuery.
See https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html
Returns:
| Type | Description |
|---|---|
list[object] | The filters of this SearchQuery |
return_type property writable
Gets the return_type of this SearchQuery.
Returns:
| Type | Description |
|---|---|
SearchReturnType | The return_type of this SearchQuery |
search_string property writable
Gets the search_string of this SearchQuery.
Represents the plain text search query
Returns:
| Type | Description |
|---|---|
str | The search_string of this SearchQuery |
size property writable
Gets the size of this SearchQuery.
Returns:
| Type | Description |
|---|---|
int | The size of this SearchQuery |
sort property writable
Gets the sort of this SearchQuery.
Returns:
| Type | Description |
|---|---|
Sort | The sort of this SearchQuery |
structured_query property writable
Gets the structured_query of this SearchQuery.
Represents structured query language search
Returns:
| Type | Description |
|---|---|
str | The structured_query of this SearchQuery |
__contains__(key)
Checks if the given value is a key in this object
__eq__(other)
Returns true if both objects are equal
__getitem__(key)
Returns the value of key
__init__(return_type=None, structured_query=None, search_string=None, filters=None, all_data=False, sort=None, size=None)
SearchQuery - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
return_type | (SearchReturnType, optional) | , defaults to None | None |
structured_query | (str, optional) | Represents structured query language search, defaults to None | None |
search_string | (str, optional) | Represents the plain text search query, defaults to None | None |
filters | (list[object], optional) | See https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html, defaults to None | None |
all_data | (bool, optional) | When set will include all data that the user does not have access to read, defaults to False | False |
sort | (Sort, optional) | , defaults to None | None |
size | (int, optional) | , defaults to None | None |
__ne__(other)
Returns true if both objects are not equal
__repr__()
For print and pprint
__setitem__(key, value)
Sets the value of key
get(key, default=None)
Get the value of the provided json property, or default
items()
Returns the list of json property to value mapping
keys()
Returns the list of json properties in the object
positional_to_model(value) staticmethod
Converts a positional argument to a model value
return_value()
Unwraps return value from model
to_dict()
Returns the model properties as a dict
to_str()
Returns the string representation of the model
values()
Returns the list of values in the object