Package ai.vespa.feed.client

Class JsonFeeder

java.lang.Object

ai.vespa.feed.client.JsonFeeder

All Implemented Interfaces:

Closeable, AutoCloseable

public class JsonFeeder
extends Object
implements Closeable

Author:

jonmv, bjorncs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonFeeder.Builder
static interface	JsonFeeder.ResultCallback

Method Summary

Modifier and Type	Method	Description
static JsonFeeder.Builder	builder(FeedClient client)
void	close()
CompletableFuture<Void>	feedMany(InputStream jsonStream)	Same as feedMany(InputStream, ResultCallback), but without a provided JsonFeeder.ResultCallback instance.
CompletableFuture<Void>	feedMany(InputStream jsonStream, JsonFeeder.ResultCallback resultCallback)	Feeds a stream containing a JSON array of feed operations on the form
CompletableFuture<Result>	feedSingle(String json)	Feeds single JSON feed operations on the form

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static JsonFeeder.Builder builder(FeedClient client)

feedSingle

public CompletableFuture<Result> feedSingle(String json)

Feeds single JSON feed operations on the form

    {
      "id": "id:ns:type::boo",
      "fields": { ... document fields ... }
    }
  

Exceptional completion will use be an instance of FeedException or one of its sub-classes.

feedMany

public CompletableFuture<Void> feedMany(InputStream jsonStream,
                                        JsonFeeder.ResultCallback resultCallback)

Feeds a stream containing a JSON array of feed operations on the form

     [
       {
         "id": "id:ns:type::boo",
         "fields": { ... document fields ... }
       },
       {
         "put": "id:ns:type::foo",
         "fields": { ... document fields ... }
       },
       {
         "update": "id:ns:type:n=4:bar",
         "create": true,
         "fields": { ... partial update fields ... }
       },
       {
         "remove": "id:ns:type:g=foo:bar",
         "condition": "type.baz = \"bax\""
       },
       ...
     ]
 

Note that "id" is an alias for the document put operation. Exceptional completion will use be an instance of FeedException or one of its sub-classes. The input stream will be closed upon exhaustion, or error.

feedMany

public CompletableFuture<Void> feedMany(InputStream jsonStream)

Same as feedMany(InputStream, ResultCallback), but without a provided JsonFeeder.ResultCallback instance.

See Also:

for details.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException