Package com.atlan.model.search
Class IndexSearchDSL
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.search.IndexSearchDSL
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
WorkflowSearchRequest
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
IndexSearchDSL.IndexSearchDSLBuilder<C extends IndexSearchDSL,
B extends IndexSearchDSL.IndexSearchDSLBuilder<C, B>> Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,
B extends AtlanObject.AtlanObjectBuilder<C, B>> -
Field Summary
Fields inherited from class com.atlan.model.core.AtlanObject
rawJsonObject
-
Constructor Summary
ModifierConstructorDescriptionprotected
-
Method Summary
Modifier and TypeMethodDescriptionstatic IndexSearchDSL.IndexSearchDSLBuilder<?,
?> static IndexSearchDSL.IndexSearchDSLBuilder<?,
?> builder
(co.elastic.clients.elasticsearch._types.query_dsl.Query query) Build a search using the provided query and default options.protected boolean
boolean
(Optional) Aggregation to apply to the query.getFrom()
Starting point for paging.co.elastic.clients.elasticsearch._types.query_dsl.Query
getQuery()
Query to run.getSize()
Number of results to return per page.List<co.elastic.clients.elasticsearch._types.SortOptions>
getSort()
(Optional) Properties by which to sort the results.When true, specify the precise number of results in the response, otherwise estimate and max-out at 10,000.int
hashCode()
static IndexSearchDSL
of
(co.elastic.clients.elasticsearch._types.query_dsl.Query query) Build a search using the provided query and default options.toString()
Methods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJson
-
Field Details
-
DEFAULT_PAGE_SIZE
public static final int DEFAULT_PAGE_SIZE- See Also:
-
-
Constructor Details
-
IndexSearchDSL
-
-
Method Details
-
of
Build a search using the provided query and default options.- Parameters:
query
- to use for the search- Returns:
- the search DSL for that query, with default options
-
builder
public static IndexSearchDSL.IndexSearchDSLBuilder<?,?> builder(co.elastic.clients.elasticsearch._types.query_dsl.Query query) Build a search using the provided query and default options.- Parameters:
query
- to use for the search- Returns:
- a search DSL builder for that query, with default options
-
_internal
-
toBuilder
-
getFrom
Starting point for paging. Defaults to 0 (very first result) if not overridden. -
getSize
Number of results to return per page. Defaults to 300 results per page if not overridden. -
getTrackTotalHits
When true, specify the precise number of results in the response, otherwise estimate and max-out at 10,000. (Defaults to true.) -
getAggregations
public Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> getAggregations()(Optional) Aggregation to apply to the query. -
getQuery
public co.elastic.clients.elasticsearch._types.query_dsl.Query getQuery()Query to run. -
getSort
(Optional) Properties by which to sort the results. -
equals
- Overrides:
equals
in classAtlanObject
-
canEqual
- Overrides:
canEqual
in classAtlanObject
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAtlanObject
-
toString
Description copied from class:AtlanObject
- Overrides:
toString
in classAtlanObject
-