object ElasticRequest
- Alphabetic
- By Inheritance
- ElasticRequest
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed trait AggregateRequest extends ElasticRequest[AggregateResult]
- sealed trait BulkRequest extends ElasticRequest[BulkResponse] with HasRefresh[BulkRequest] with HasRouting[BulkRequest]
- sealed trait CountRequest extends ElasticRequest[Int] with HasRouting[CountRequest]
- sealed trait CreateIndexRequest extends ElasticRequest[CreationOutcome]
- sealed trait CreateOrUpdateRequest extends BulkableRequest[Unit] with HasRefresh[CreateOrUpdateRequest] with HasRouting[CreateOrUpdateRequest]
- sealed trait CreateRequest extends BulkableRequest[DocumentId] with HasRefresh[CreateRequest] with HasRouting[CreateRequest]
- sealed trait CreateWithIdRequest extends BulkableRequest[CreationOutcome] with HasRefresh[CreateWithIdRequest] with HasRouting[CreateWithIdRequest]
- sealed trait DeleteByIdRequest extends BulkableRequest[DeletionOutcome] with HasRefresh[DeleteByIdRequest] with HasRouting[DeleteByIdRequest]
- sealed trait DeleteByQueryRequest extends ElasticRequest[DeletionOutcome] with HasRefresh[DeleteByQueryRequest] with HasRouting[DeleteByQueryRequest]
- sealed trait DeleteIndexRequest extends ElasticRequest[DeletionOutcome]
- sealed trait ExistsRequest extends ElasticRequest[Boolean] with HasRouting[ExistsRequest]
- sealed trait GetByIdRequest extends ElasticRequest[GetResult] with HasRefresh[GetByIdRequest] with HasRouting[GetByIdRequest]
- sealed trait KNNRequest extends ElasticRequest[KNNSearchResult] with HasRouting[KNNRequest]
- sealed trait RefreshRequest extends ElasticRequest[Boolean]
- sealed trait SearchAndAggregateRequest extends ElasticRequest[SearchAndAggregateResult] with HasFrom[SearchAndAggregateRequest] with HasHighlights[SearchAndAggregateRequest] with HasRouting[SearchAndAggregateRequest] with HasSearchAfter[SearchAndAggregateRequest] with HasSize[SearchAndAggregateRequest] with HasSort[SearchAndAggregateRequest] with HasSourceFiltering[SearchAndAggregateRequest]
- sealed trait SearchRequest extends ElasticRequest[SearchResult] with HasFrom[SearchRequest] with HasHighlights[SearchRequest] with HasRouting[SearchRequest] with HasSearchAfter[SearchRequest] with HasSize[SearchRequest] with HasSort[SearchRequest] with HasSourceFiltering[SearchRequest]
- sealed trait UpdateByQueryRequest extends ElasticRequest[UpdateByQueryResult] with HasRefresh[UpdateByQueryRequest] with HasRouting[UpdateByQueryRequest]
- sealed trait UpdateRequest extends BulkableRequest[UpdateOutcome] with HasRefresh[UpdateRequest] with HasRouting[UpdateRequest]
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def aggregate[I](selectors: I, aggregation: ElasticAggregation)(implicit arg0: IndexSelector[I]): AggregateRequest
Constructs an instance of AggregateRequest using the specified parameters.
Constructs an instance of AggregateRequest using the specified parameters.
- selectors
the name of the index or more indices to aggregate on
- aggregation
the desired ElasticAggregation to perform
- returns
an instance of AggregateRequest that represents the aggregation to be performed.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def bulk(requests: BulkableRequest[_]*): BulkRequest
Constructs an instance of BulkRequest using the specified requests.
Constructs an instance of BulkRequest using the specified requests.
- requests
a list of requests that will be executed as a bulk
- returns
an instance of BulkRequest that represents the bulk operation to be performed.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def count(index: elasticsearch.IndexName, query: ElasticQuery[_]): CountRequest
Constructs an instance of CountRequest for counting documents satisfy the query.
Constructs an instance of CountRequest for counting documents satisfy the query.
- index
the name of the Elasticsearch index to count documents from
- query
the ElasticQuery object to query documents that will be counted
- returns
an instance of CountRequest that represents the count operation to be performed.
- final def count(index: elasticsearch.IndexName): CountRequest
Constructs an instance of CountRequest for whole specified index.
Constructs an instance of CountRequest for whole specified index.
- index
the name of the index to count documents from
- returns
an instance of CountRequest that represents the count operation to be performed.
- final def create[A](index: elasticsearch.IndexName, id: DocumentId, doc: A)(implicit arg0: Schema[A]): CreateWithIdRequest
Constructs an instance of CreateWithIdRequest used for creating a document with specified ID in the specified index.
Constructs an instance of CreateWithIdRequest used for creating a document with specified ID in the specified index.
- A
the type of the document to be created. An implicit
Schemainstance must be in scope for this type- index
the name of the index to create the document in
- id
the ID of the new document
- doc
the document to be created, represented by an instance of type
A- returns
an instance of CreateRequest that represents the create with id operation to be performed.
- final def create[A](index: elasticsearch.IndexName, doc: A)(implicit arg0: Schema[A]): CreateRequest
Constructs an instance of CreateRequest used for creating a document in the specified index.
Constructs an instance of CreateRequest used for creating a document in the specified index.
- A
the type of the document to be created. An implicit
Schemainstance must be in scope for this type- index
the name of the index to create the document in
- doc
the document to be created, represented by an instance of type
A- returns
an instance of CreateRequest that represents the create operation to be performed.
- final def createIndex(index: elasticsearch.IndexName, definition: String): CreateIndexRequest
Constructs an instance of CreateIndexRequest used for creating an index with a specified definition.
Constructs an instance of CreateIndexRequest used for creating an index with a specified definition.
- index
the name of the index to be created
- definition
the settings for the index
- returns
an instance of CreateIndexRequest that represents the create index operation to be performed.
- final def createIndex(index: elasticsearch.IndexName): CreateIndexRequest
Constructs an instance of CreateIndexRequest used for creating an empty index.
Constructs an instance of CreateIndexRequest used for creating an empty index.
- index
the name of the index to be created
- returns
an instance of CreateIndexRequest that represents the create index operation to be performed.
- final def deleteById(index: elasticsearch.IndexName, id: DocumentId): DeleteByIdRequest
Constructs an instance of DeleteByIdRequest used for deleting a document from the specified index by specified ID.
Constructs an instance of DeleteByIdRequest used for deleting a document from the specified index by specified ID.
- index
the name of the index to delete the document from
- id
the ID of the document to be deleted
- returns
an instance of DeleteByIdRequest that represents delete by id operation to be performed.
- final def deleteByQuery(index: elasticsearch.IndexName, query: ElasticQuery[_]): DeleteByQueryRequest
Constructs an instance of DeleteByQueryRequest used for deleting documents from the specified index that satisfy specified query.
Constructs an instance of DeleteByQueryRequest used for deleting documents from the specified index that satisfy specified query.
- index
the name of the index to delete documents from
- query
the ElasticQuery object to query documents which will be deleted
- returns
an instance of DeleteByQueryRequest that represents delete by query operation to be performed.
- final def deleteIndex(index: elasticsearch.IndexName): DeleteIndexRequest
Constructs an instance of DeleteIndexRequest used for deleting an index by specified name.
Constructs an instance of DeleteIndexRequest used for deleting an index by specified name.
- index
the name of the index to be deleted
- returns
an instance of DeleteIndexRequest that represents delete index operation to be performed.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def exists(index: elasticsearch.IndexName, id: DocumentId): ExistsRequest
Constructs an instance of ExistsRequest used for checking whether document exists.
Constructs an instance of ExistsRequest used for checking whether document exists.
- index
the name of the index where the document may be located
- id
the ID of the document to check for existence
- returns
an instance of ExistsRequest that represents exists operation to be performed.
- final def getById(index: elasticsearch.IndexName, id: DocumentId): GetByIdRequest
Constructs an instance of GetByIdRequest used for retrieving the document from specified index, by specified ID.
Constructs an instance of GetByIdRequest used for retrieving the document from specified index, by specified ID.
- index
the name of the index where the document is located
- id
the ID of the document to retrieve
- returns
an instance of GetByIdRequest that represents get by id operation to be performed.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def knnSearch[I](selectors: I, query: KNNQuery[_])(implicit arg0: IndexSelector[I]): KNNRequest
Constructs an instance of KNNRequest used for performing a k-nearest neighbour (kNN) search.
Constructs an instance of KNNRequest used for performing a k-nearest neighbour (kNN) search. Given a query vector, it finds the k closest vectors and returns those documents as search hits.
- selectors
the name of the index or more indices to search in
- query
an instance of zio.elasticsearch.query.KNNQuery to run
- returns
an instance of KNNRequest that represents k-nearest neighbour (kNN) operation to be performed.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def refresh[I](selectors: I)(implicit arg0: IndexSelector[I]): RefreshRequest
Constructs an instance of RefreshRequest used for refreshing an index with the specified name.
Constructs an instance of RefreshRequest used for refreshing an index with the specified name.
- selectors
the name of the index or more indices to be refreshed
- returns
an instance of RefreshRequest that represents refresh operation to be performed.
- final def search[I](selectors: I, query: ElasticQuery[_], aggregation: ElasticAggregation)(implicit arg0: IndexSelector[I]): SearchAndAggregateRequest
Constructs an instance of SearchAndAggregateRequest using the specified parameters.
Constructs an instance of SearchAndAggregateRequest using the specified parameters.
- selectors
the name of the index or more indices to search and aggregate in
- query
an ElasticQuery object for querying documents
- aggregation
an ElasticAggregation object for aggregating queried documents
- returns
an instance of SearchAndAggregateRequest that represents search and aggregate operations to be performed.
- final def search[I](selectors: I, query: ElasticQuery[_])(implicit arg0: IndexSelector[I]): SearchRequest
Constructs an instance of SearchRequest using the specified parameters.
Constructs an instance of SearchRequest using the specified parameters.
- selectors
the name of the index or more indices to search in
- query
the ElasticQuery object representing the search query to execute
- returns
an instance of SearchRequest that represents search operation to be performed.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def update[A](index: elasticsearch.IndexName, id: DocumentId, doc: A)(implicit arg0: Schema[A]): UpdateRequest
Constructs an instance of UpdateRequest used for updating the document in the specified index, by specified ID.
Constructs an instance of UpdateRequest used for updating the document in the specified index, by specified ID.
- A
the type of the document to be updated. An implicit
Schemainstance must be in scope for this type- index
the name of the index containing the document to update
- id
the ID of the document to update
- doc
the document to be updated, represented by an instance of type
A- returns
an instance of UpdateRequest that represents update operation to be performed.
- final def updateAllByQuery(index: elasticsearch.IndexName, script: Script): UpdateByQueryRequest
Constructs an instance of UpdateByQueryRequest used for updating all documents in the specified index.
Constructs an instance of UpdateByQueryRequest used for updating all documents in the specified index.
- index
the name of the index to update documents in
- script
a script containing the update logic to apply
- returns
an instance of UpdateByQueryRequest that represents update all operation to be performed.
- final def updateByQuery(index: elasticsearch.IndexName, query: ElasticQuery[_], script: Script): UpdateByQueryRequest
Constructs an instance of UpdateByQueryRequest used for satisfying documents matching specified query in the specified index.
Constructs an instance of UpdateByQueryRequest used for satisfying documents matching specified query in the specified index.
- index
the name of the index to update documents in
- query
an ElasticQuery object representing a search query used to find documents to update
- script
a script containing the update logic to apply
- returns
an instance of UpdateByQueryRequest that represents update by query operation to be performed.
- final def updateByScript(index: elasticsearch.IndexName, id: DocumentId, script: Script): UpdateRequest
Constructs an instance of UpdateRequest used for updating the document with specified ID in the specified index.
Constructs an instance of UpdateRequest used for updating the document with specified ID in the specified index.
- index
the name of the index containing the document to update
- id
the ID of the document to update
- script
a script containing the update logic to apply to the document
- returns
an instance of UpdateRequest that represents update by script operation to be performed.
- final def upsert[A](index: elasticsearch.IndexName, id: DocumentId, doc: A)(implicit arg0: Schema[A]): CreateOrUpdateRequest
Constructs an instance of CreateOrUpdateRequest used for creating or updating the document in the specified index with specified ID.
Constructs an instance of CreateOrUpdateRequest used for creating or updating the document in the specified index with specified ID.
- A
the type of the document to be created or updated. An implicit
Schemainstance must be in scope for this type- index
the name of the index to create or update the document in
- id
the ID of the document to be created or updated
- doc
the document to be created or updated, represented by an instance of type
A- returns
an instance of CreateOrUpdateRequest that represents upsert operation to be performed.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])