org.apache.nutch.indexwriter.elastic

## Class ElasticIndexWriter

- java.lang.Object
- - org.apache.nutch.indexwriter.elastic.ElasticIndexWriter

- All Implemented Interfaces:
    Configurable, IndexWriter, Pluggable

      public class ElasticIndexWriter
      extends Object
      implements IndexWriter

  Sends NutchDocuments to a configured Elasticsearch index.

- - ### Field Summary

    - ### Fields inherited from interface org.apache.nutch.indexer.IndexWriter

      `X_POINT_ID`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ElasticIndexWriter()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected BulkProcessor.Listener` | `bulkProcessorListener()` Generates a default BulkProcessor.Listener
    `void` | `close()`
    `void` | `commit()`
    `void` | `delete(String key)`
    `Map<String,Map.Entry<String,Object>>` | `describe()` Returns `Map` with the specific parameters the IndexWriter instance can take.
    `Configuration` | `getConf()`
    `protected RestHighLevelClient` | `makeClient(IndexWriterParams parameters)` Generates a RestHighLevelClient with the hosts given
    `void` | `open(Configuration conf, String name)`
    `void` | `open(IndexWriterParams parameters)` Initializes the internal variables from a given index writer configuration.
    `void` | `setConf(Configuration conf)`
    `void` | `update(NutchDocument doc)`
    `void` | `write(NutchDocument doc)`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ElasticIndexWriter

          public ElasticIndexWriter()

  - ### Method Detail

    - #### open

          public void open(Configuration conf,
                           String name)
                    throws IOException

      Specified by:
        `open` in interface `IndexWriter`
      Throws:
        `IOException`

    - #### open

          public void open(IndexWriterParams parameters)
                    throws IOException

      Initializes the internal variables from a given index writer configuration.
      Specified by:
        `open` in interface `IndexWriter`
      Parameters:
        `parameters` - Params from the index writer configuration.
      Throws:
        `IOException` - Some exception thrown by writer.

    - #### makeClient

          protected RestHighLevelClient makeClient(IndexWriterParams parameters)
                                            throws IOException

      Generates a RestHighLevelClient with the hosts given
      Throws:
        `IOException`

    - #### bulkProcessorListener

          protected BulkProcessor.Listener bulkProcessorListener()

      Generates a default BulkProcessor.Listener

    - #### write

          public void write(NutchDocument doc)
                     throws IOException

      Specified by:
        `write` in interface `IndexWriter`
      Throws:
        `IOException`

    - #### delete

          public void delete(String key)
                      throws IOException

      Specified by:
        `delete` in interface `IndexWriter`
      Throws:
        `IOException`

    - #### update

          public void update(NutchDocument doc)
                      throws IOException

      Specified by:
        `update` in interface `IndexWriter`
      Throws:
        `IOException`

    - #### commit

          public void commit()
                      throws IOException

      Specified by:
        `commit` in interface `IndexWriter`
      Throws:
        `IOException`

    - #### close

          public void close()
                     throws IOException

      Specified by:
        `close` in interface `IndexWriter`
      Throws:
        `IOException`

    - #### describe

          public Map<String,Map.Entry<String,Object>> describe()

      Returns `Map` with the specific parameters the IndexWriter instance can take.
      Specified by:
        `describe` in interface `IndexWriter`
      Returns:
        The values of each row. It must have the form >.

    - #### setConf

          public void setConf(Configuration conf)

      Specified by:
        `setConf` in interface `Configurable`

    - #### getConf

          public Configuration getConf()

      Specified by:
        `getConf` in interface `Configurable`

Copyright © 2020 The Apache Software Foundation