Interface QueryDefinitionModel
-
- All Known Implementing Classes:
BaseQueryDefinitionModel
public interface QueryDefinitionModel
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNodegetCustomFilter()Returns the JsonNode that will be used as input to compose a safe ES query.StringgetDescription()Returns the optional description of this query definition, describing where and how it might be used.StringgetKey()Returns the business key usually used to reference or lookup a query definition regardless of its version.StringgetName()Returns the name of this query definition.Map<String,QueryParameter>getParameters()Map<String,QuerySortParameter>getSortParameters()StringgetSourceIndex()Returns the name of the index on which the query will be performed on.StringgetSubType()StringgetTemplateContent()Returns the template content that will be used to parse to a ES query by a template engine.StringgetTemplateFilter()Returns the template content that will be used to first parse by a template engine and then use as input to compose a safe ES query.StringgetTemplateResource()Returns the resource that will be used to parse to a ES query by a template engine.StringgetType()
-
-
-
Method Detail
-
getKey
String getKey()
Returns the business key usually used to reference or lookup a query definition regardless of its version.
-
getName
String getName()
Returns the name of this query definition.
-
getDescription
String getDescription()
Returns the optional description of this query definition, describing where and how it might be used.
-
getSourceIndex
String getSourceIndex()
Returns the name of the index on which the query will be performed on.
-
getType
String getType()
-
getSubType
String getSubType()
-
getCustomFilter
com.fasterxml.jackson.databind.JsonNode getCustomFilter()
Returns the JsonNode that will be used as input to compose a safe ES query.
-
getTemplateFilter
String getTemplateFilter()
Returns the template content that will be used to first parse by a template engine and then use as input to compose a safe ES query.
-
getTemplateResource
String getTemplateResource()
Returns the resource that will be used to parse to a ES query by a template engine.
-
getTemplateContent
String getTemplateContent()
Returns the template content that will be used to parse to a ES query by a template engine.
-
getParameters
Map<String,QueryParameter> getParameters()
-
getSortParameters
Map<String,QuerySortParameter> getSortParameters()
-
-