diff options
| author | Jon Bratseth <bratseth@oath.com> | 2019-01-17 15:57:56 +0100 |
|---|---|---|
| committer | Jon Bratseth <bratseth@oath.com> | 2019-01-17 15:57:56 +0100 |
| commit | 70644630b7d44eb44df2ee71547f7eb4b3db0c9c (patch) | |
| tree | 26da7bc273200c81cca0bd9ebf6de46aba6f138f /vespa-http-client | |
| parent | a915a96bed50b4e4ec4953e712b7aab11a246e61 (diff) | |
Add more javadoc
Diffstat (limited to 'vespa-http-client')
| -rw-r--r-- | vespa-http-client/src/main/java/com/yahoo/vespa/http/client/FeedClient.java | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/vespa-http-client/src/main/java/com/yahoo/vespa/http/client/FeedClient.java b/vespa-http-client/src/main/java/com/yahoo/vespa/http/client/FeedClient.java index 1028100fbcf..18267e5209e 100644 --- a/vespa-http-client/src/main/java/com/yahoo/vespa/http/client/FeedClient.java +++ b/vespa-http-client/src/main/java/com/yahoo/vespa/http/client/FeedClient.java @@ -51,7 +51,9 @@ public interface FeedClient extends AutoCloseable { * Don't call stream() after close is called. * * @param documentId the document id of the document. - * @param operationId the id to use for this operation, or null to let the client decide an operation id + * @param operationId the id to use for this operation, or null to let the client decide an operation id. + * This id must be unique for every operation. Passing the operation id allows clients + * to prepare to receive a response for it before issuing the operation to the client. * @param documentData the document data as JSON or XML (as specified when using the factory to create the API) * @param context a context object which will be accessible in the result of the callback, or null if none */ |