summaryrefslogtreecommitdiffstats
path: root/vespa-feed-client-api
diff options
context:
space:
mode:
authorjonmv <venstad@gmail.com>2022-11-25 10:24:45 +0100
committerjonmv <venstad@gmail.com>2022-11-25 10:24:45 +0100
commit50eeeb8ef8ee12bf51059b3c5a6deb3df7390894 (patch)
treeff5cc3955970796fa785d858a3ca5aa579d9628a /vespa-feed-client-api
parent0ef9b187f6dc333ead41f52ec3124bdf5aedd23e (diff)
Improve doc
Diffstat (limited to 'vespa-feed-client-api')
-rw-r--r--vespa-feed-client-api/src/main/java/ai/vespa/feed/client/FeedClientBuilder.java11
1 files changed, 9 insertions, 2 deletions
diff --git a/vespa-feed-client-api/src/main/java/ai/vespa/feed/client/FeedClientBuilder.java b/vespa-feed-client-api/src/main/java/ai/vespa/feed/client/FeedClientBuilder.java
index b7c51a0c5c9..e8cb5344aff 100644
--- a/vespa-feed-client-api/src/main/java/ai/vespa/feed/client/FeedClientBuilder.java
+++ b/vespa-feed-client-api/src/main/java/ai/vespa/feed/client/FeedClientBuilder.java
@@ -22,10 +22,17 @@ public interface FeedClientBuilder {
String PREFERRED_IMPLEMENTATION_PROPERTY = "vespa.feed.client.builder.implementation";
- /** Creates a builder for a single container endpoint **/
+ /**
+ * Creates a builder for a single feed container endpoint.
+ * This is for feeding against a container cluster with a load balancer in front of it.
+ **/
static FeedClientBuilder create(URI endpoint) { return create(Collections.singletonList(endpoint)); }
- /** Creates a builder for multiple container endpoints **/
+ /**
+ * Creates a builder which <em>distributes</em> the feed across the given feed container endpoints.
+ * This is for feeding directly against container nodes, i.e., when no load balancer sits in front of these.
+ * Each feed operation is sent to <em>one</em> of the endpoints, <strong>not all of them</strong>!
+ */
static FeedClientBuilder create(List<URI> endpoints) {
return Helper.getFeedClientBuilderSupplier().get().setEndpointUris(endpoints);
}