Class

elastic.client.ElasticClient

EsIndex

Related Doc: package ElasticClient

Permalink

case class EsIndex(name: String, type: Option[String] = None) extends Index[JsonR] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, Index[JsonR], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EsIndex
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Index
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EsIndex(name: String, type: Option[String] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def /(type: String): Index[JsonR]

    Permalink
    Definition Classes
    EsIndexIndex
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def bulk[D](publisher: Publisher[Bulk[D]], batchSize: Int)(implicit qWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Publisher[BulkResponse[JsonR]]

    Permalink

    Bulk operation for the current index see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

    Bulk operation for the current index see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

    D

    the type of the document

    publisher

    a org.reactivestreams.Publisher (see reactive streams) of elastic.api.Bulk

    batchSize

    the size of the packet of bulk operations to send to elastic

    docWriter

    document to json object conversion

    bulkOpWriter

    elastic.api.Bulk to json object conversion

    sReader

    string to json object conversion

    bReader

    json object to elastic.api.BulkResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a org.reactivestreams.Publisher (see reactive streams) of elastic.api.BulkResponse

    Definition Classes
    EsIndexIndex
  7. def bulkFlow[D](batchSize: Int)(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Flow[Bulk[D], BulkResponse[JsonR], NotUsed]

    Permalink

    A akka stream flow to bulk datas.

    A akka stream flow to bulk datas.

    D

    the type of the document

    batchSize

    the size of the packet of bulk operations to send to elastic

    sWrites

    json to string conversion

    docWriter

    document to json object conversion

    bulkOpWriter

    elastic.api.Bulk to json object conversion

    sReader

    string to json object conversion

    bReader

    json object to elastic.api.BulkResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a akka.stream.scaladsl.Flow that ingest elastic.api.Bulk and out elastic.api.BulkResponse

    Definition Classes
    EsIndexIndex
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def delete(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexOps], ec: ExecutionContext): Future[IndexOps]

    Permalink

    Delete index operation

    Delete index operation

    sReader

    string to json object conversion

    jsonReader

    a json object to elastic.api.IndexOps conversion

    ec

    ExecutionContext for future execution

    Definition Classes
    EsIndexIndex
  10. def delete(id: String, refresh: Boolean = false, routing: Option[String] = None)(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

    Permalink

    Delete a document by its id.

    Delete a document by its id.

    id

    of the document

    sReader

    string to json object conversion

    jsonReader

    json object to elastic.api.IndexResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a elastic.api.IndexResponse object

    Definition Classes
    EsIndexIndex
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get(id: String, routing: Option[String], fields: Seq[String], _source: Boolean)(implicit sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, GetResponse[JsonR]], ec: ExecutionContext): Future[GetResponse[JsonR]]

    Permalink

    Get a document by id

    Get a document by id

    id

    id of the document

    routing

    the routing key

    fields

    a scala.Seq of fields to filter the source

    _source

    if false, the source is ignored

    sReader

    string to json object conversion

    jsonReader

    json object to elastic.api.GetResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a elastic.api.GetResponse

    Definition Classes
    EsIndexIndex
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def index[D](data: D, id: Option[String], version: Option[Int], versionType: Option[VersionType], create: Boolean, routing: Option[String], parent: Option[String], refresh: Boolean, timeout: Option[String], consistency: Option[Consistency], detectNoop: Boolean)(implicit writer: Writer[D, JsonR], strWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

    Permalink

    Index operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html

    Index operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html

    D

    the type of the document

    data

    document to index

    id

    optional id of the document

    version

    current version of the document

    versionType

    type of the version

    create

    if true an excpetion is thrown if the document allready exists

    routing

    routing key

    parent

    parent id if there is a parent child relation

    refresh

    if true, the index will be refresh

    timeout

    a timeout

    consistency

    consistency level ALL, QUORUM, ONE

    detectNoop

    detect if the version should be increase

    writer

    document to json object conversion

    strWriter

    json object to string conversion

    sReader

    string to json object conversion

    jsonReader

    json object to elastic.api.IndexResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a elastic.api.IndexResponse

    Definition Classes
    EsIndexIndex
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def mget(request: MGets)(implicit sWriter: Writer[JsonR, String], jsonWriter: Writer[MGets, JsonR], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, MGetResponse[JsonR]], ec: ExecutionContext): Future[MGetResponse[JsonR]]

    Permalink

    Multiple get operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html

    Multiple get operation see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html

    request

    multiple get request : elastic.api.MGets

    sWriter

    json to string conversion

    jsonWriter

    elastic.api.MGets to json object conversion

    sReader

    string to json object conversion

    jsonReader

    json object to elastic.api.MGetResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a elastic.api.MGetResponse response

    Definition Classes
    EsIndexIndex
  18. val name: String

    Permalink
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def oneBulk[D](bulk: Seq[Bulk[D]])(implicit sWrites: Writer[JsonR, String], docWriter: Writer[D, JsonR], bulkOpWriter: Writer[BulkOpType, JsonR], sReader: Reader[String, JsonR], bReader: Reader[JsonR, BulkResponse[JsonR]], ec: ExecutionContext): Future[BulkResponse[JsonR]]

    Permalink

    A atomic bulk opération see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

    A atomic bulk opération see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

    D

    the type of the document

    bulk

    a Seq of elastic.api.Bulk to send in bulk

    sWrites

    json to string conversion

    docWriter

    document to json object conversion

    bulkOpWriter

    elastic.api.Bulk to json object conversion

    sReader

    string to json object conversion

    bReader

    json object to elastic.api.BulkResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a elastic.api.BulkResponse

    Definition Classes
    EsIndexIndex
  23. def scroll[Q](query: Q, scroll: String, size: Int)(implicit qWrites: Writer[Q, String], jsonWriter: Writer[Scroll, JsonR], sWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Source[SearchResponse[JsonR], NotUsed]

    Permalink

    The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result.

    The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result. All the result of the search are returned in an asynchronous stream.

    Q

    the query object type

    query

    the query to execute

    qWrites

    Query to json object conversion

    sReader

    string to json conversion

    jsonReader

    json string to json object conversion

    ec

    ExecutionContext for future execution

    returns

    a org.reactivestreams.Publisher (see reactive streams) of elastic.api.SearchResponse

    Definition Classes
    EsIndexIndex
  24. def scrollPublisher[Q](query: Q, scroll: String, size: Int = 20)(implicit qWrites: Writer[Q, String], jsonWriter: Writer[Scroll, JsonR], sWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Publisher[SearchResponse[JsonR]]

    Permalink

    The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result.

    The scroll search return a org.reactivestreams.Publisher (see reactives streams) of result. All the result of the search are returned in an asynchronous stream.

    Q

    the query object type

    query

    the query to execute

    qWrites

    Query to json object conversion

    sReader

    string to json conversion

    jsonReader

    json string to json object conversion

    ec

    ExecutionContext for future execution

    returns

    a org.reactivestreams.Publisher (see reactive streams) of elastic.api.SearchResponse

    Definition Classes
    EsIndexIndex
  25. def search[Q](query: Q)(implicit qWrites: Writer[Q, String], sReads: Reader[String, JsonR], jsonReader: Reader[JsonR, SearchResponse[JsonR]], ec: ExecutionContext): Future[SearchResponse[JsonR]]

    Permalink

    Search operation on this index.

    Search operation on this index.

    Q

    type of the query object

    query

    the search query object

    qWrites

    query to json object conversion

    sReads

    string to json object conversion

    jsonReader

    json object to elastic.api.SearchResponse conversion

    ec

    ExecutionContext for future execution

    returns

    a elastic.api.SearchResponse

    Definition Classes
    EsIndexIndex
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. val type: Option[String]

    Permalink
  28. def update[D](data: D, id: String, version: Option[Int], versionType: Option[VersionType], retry_on_conflict: Option[Int], routing: Option[String], parent: Option[String], timeout: Option[String], refresh: Boolean, wait_for_active_shards: Option[Boolean])(implicit writer: Writer[D, JsonR], strWriter: Writer[JsonR, String], sReader: Reader[String, JsonR], jsonReader: Reader[JsonR, IndexResponse[JsonR]], ec: ExecutionContext): Future[IndexResponse[JsonR]]

    Permalink

    Update operation : index operation with create = false and id required.

    Update operation : index operation with create = false and id required.

    D

    the type of the document

    data

    document to index

    id

    id of the document

    version

    current version of the document

    versionType

    type of the version

    routing

    routing key

    parent

    parent id if there is a parent child relation

    timeout

    a timeout

    refresh

    if true, the index will be refresh

    writer

    document to json object conversion

    strWriter

    json object to string conversion

    sReader

    string to json object conversion

    jsonReader

    json object to elastic.api.IndexResponse conversion

    returns

    a elastic.api.IndexResponse

    Definition Classes
    EsIndexIndex
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Index[JsonR]

Inherited from AnyRef

Inherited from Any

Ungrouped