aboutsummaryrefslogtreecommitdiffstats
path: root/vespa-feed-client/abi-spec.json
blob: e77f71fd2c56b952a49f202ca90c4bbde8169700 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
{
  "ai.vespa.feed.client.BenchmarkingCluster": {
    "superClass": "java.lang.Object",
    "interfaces": [
      "ai.vespa.feed.client.Cluster"
    ],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(ai.vespa.feed.client.Cluster)",
      "public void dispatch(ai.vespa.feed.client.HttpRequest, java.util.concurrent.CompletableFuture)",
      "public ai.vespa.feed.client.OperationStats stats()",
      "public void close()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.DocumentId": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public static ai.vespa.feed.client.DocumentId of(java.lang.String, java.lang.String, java.lang.String)",
      "public static ai.vespa.feed.client.DocumentId of(java.lang.String, java.lang.String, long, java.lang.String)",
      "public static ai.vespa.feed.client.DocumentId of(java.lang.String, java.lang.String, java.lang.String, java.lang.String)",
      "public static ai.vespa.feed.client.DocumentId of(java.lang.String)",
      "public java.lang.String documentType()",
      "public java.lang.String namespace()",
      "public java.util.OptionalLong number()",
      "public java.util.Optional group()",
      "public java.lang.String userSpecific()",
      "public boolean equals(java.lang.Object)",
      "public int hashCode()",
      "public java.lang.String toString()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.DynamicThrottler": {
    "superClass": "ai.vespa.feed.client.StaticThrottler",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(ai.vespa.feed.client.FeedClientBuilder)",
      "public void sent(long, java.util.concurrent.CompletableFuture)",
      "public void success()",
      "public void throttled(long)",
      "public long targetInflight()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.FeedClient$CircuitBreaker$State": {
    "superClass": "java.lang.Enum",
    "interfaces": [],
    "attributes": [
      "public",
      "final",
      "enum"
    ],
    "methods": [
      "public static ai.vespa.feed.client.FeedClient$CircuitBreaker$State[] values()",
      "public static ai.vespa.feed.client.FeedClient$CircuitBreaker$State valueOf(java.lang.String)"
    ],
    "fields": [
      "public static final enum ai.vespa.feed.client.FeedClient$CircuitBreaker$State CLOSED",
      "public static final enum ai.vespa.feed.client.FeedClient$CircuitBreaker$State HALF_OPEN",
      "public static final enum ai.vespa.feed.client.FeedClient$CircuitBreaker$State OPEN"
    ]
  },
  "ai.vespa.feed.client.FeedClient$CircuitBreaker": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public",
      "interface",
      "abstract"
    ],
    "methods": [
      "public void success()",
      "public void failure()",
      "public abstract ai.vespa.feed.client.FeedClient$CircuitBreaker$State state()"
    ],
    "fields": [
      "public static final ai.vespa.feed.client.FeedClient$CircuitBreaker FUSED"
    ]
  },
  "ai.vespa.feed.client.FeedClient$OperationType": {
    "superClass": "java.lang.Enum",
    "interfaces": [],
    "attributes": [
      "public",
      "final",
      "enum"
    ],
    "methods": [
      "public static ai.vespa.feed.client.FeedClient$OperationType[] values()",
      "public static ai.vespa.feed.client.FeedClient$OperationType valueOf(java.lang.String)"
    ],
    "fields": [
      "public static final enum ai.vespa.feed.client.FeedClient$OperationType PUT",
      "public static final enum ai.vespa.feed.client.FeedClient$OperationType UPDATE",
      "public static final enum ai.vespa.feed.client.FeedClient$OperationType REMOVE"
    ]
  },
  "ai.vespa.feed.client.FeedClient$RetryStrategy": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public",
      "interface",
      "abstract"
    ],
    "methods": [
      "public boolean retry(ai.vespa.feed.client.FeedClient$OperationType)",
      "public int retries()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.FeedClient": {
    "superClass": "java.lang.Object",
    "interfaces": [
      "java.io.Closeable"
    ],
    "attributes": [
      "public",
      "interface",
      "abstract"
    ],
    "methods": [
      "public abstract java.util.concurrent.CompletableFuture put(ai.vespa.feed.client.DocumentId, java.lang.String, ai.vespa.feed.client.OperationParameters)",
      "public abstract java.util.concurrent.CompletableFuture update(ai.vespa.feed.client.DocumentId, java.lang.String, ai.vespa.feed.client.OperationParameters)",
      "public abstract java.util.concurrent.CompletableFuture remove(ai.vespa.feed.client.DocumentId, ai.vespa.feed.client.OperationParameters)",
      "public abstract ai.vespa.feed.client.OperationStats stats()",
      "public abstract ai.vespa.feed.client.FeedClient$CircuitBreaker$State circuitBreakerState()",
      "public abstract void close(boolean)",
      "public void close()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.FeedClientBuilder": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public static ai.vespa.feed.client.FeedClientBuilder create(java.net.URI)",
      "public static ai.vespa.feed.client.FeedClientBuilder create(java.util.List)",
      "public ai.vespa.feed.client.FeedClientBuilder setConnectionsPerEndpoint(int)",
      "public ai.vespa.feed.client.FeedClientBuilder setMaxStreamPerConnection(int)",
      "public ai.vespa.feed.client.FeedClientBuilder setSslContext(javax.net.ssl.SSLContext)",
      "public ai.vespa.feed.client.FeedClientBuilder setHostnameVerifier(javax.net.ssl.HostnameVerifier)",
      "public ai.vespa.feed.client.FeedClientBuilder noBenchmarking()",
      "public ai.vespa.feed.client.FeedClientBuilder addRequestHeader(java.lang.String, java.lang.String)",
      "public ai.vespa.feed.client.FeedClientBuilder addRequestHeader(java.lang.String, java.util.function.Supplier)",
      "public ai.vespa.feed.client.FeedClientBuilder setRetryStrategy(ai.vespa.feed.client.FeedClient$RetryStrategy)",
      "public ai.vespa.feed.client.FeedClientBuilder setCircuitBreaker(ai.vespa.feed.client.FeedClient$CircuitBreaker)",
      "public ai.vespa.feed.client.FeedClientBuilder setCertificate(java.nio.file.Path, java.nio.file.Path)",
      "public ai.vespa.feed.client.FeedClientBuilder setCertificate(java.util.Collection, java.security.PrivateKey)",
      "public ai.vespa.feed.client.FeedClientBuilder setCertificate(java.security.cert.X509Certificate, java.security.PrivateKey)",
      "public ai.vespa.feed.client.FeedClientBuilder setDryrun(boolean)",
      "public ai.vespa.feed.client.FeedClientBuilder setCaCertificatesFile(java.nio.file.Path)",
      "public ai.vespa.feed.client.FeedClientBuilder setCaCertificates(java.util.Collection)",
      "public ai.vespa.feed.client.FeedClient build()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.FeedException": {
    "superClass": "java.lang.RuntimeException",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(java.lang.String)",
      "public void <init>(ai.vespa.feed.client.DocumentId, java.lang.String)",
      "public void <init>(java.lang.String, java.lang.Throwable)",
      "public void <init>(java.lang.Throwable)",
      "public void <init>(ai.vespa.feed.client.DocumentId, java.lang.Throwable)",
      "public void <init>(ai.vespa.feed.client.DocumentId, java.lang.String, java.lang.Throwable)",
      "public java.util.Optional documentId()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.GracePeriodCircuitBreaker": {
    "superClass": "java.lang.Object",
    "interfaces": [
      "ai.vespa.feed.client.FeedClient$CircuitBreaker"
    ],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(java.time.Duration, java.time.Duration)",
      "public void success()",
      "public void failure()",
      "public ai.vespa.feed.client.FeedClient$CircuitBreaker$State state()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.JsonFeeder$Builder": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public ai.vespa.feed.client.JsonFeeder$Builder withTimeout(java.time.Duration)",
      "public ai.vespa.feed.client.JsonFeeder$Builder withRoute(java.lang.String)",
      "public ai.vespa.feed.client.JsonFeeder$Builder withTracelevel(int)",
      "public ai.vespa.feed.client.JsonFeeder build()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.JsonFeeder$ResultCallback": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public",
      "interface",
      "abstract"
    ],
    "methods": [
      "public void onNextResult(ai.vespa.feed.client.Result, ai.vespa.feed.client.FeedException)",
      "public void onError(ai.vespa.feed.client.FeedException)",
      "public void onComplete()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.JsonFeeder": {
    "superClass": "java.lang.Object",
    "interfaces": [
      "java.io.Closeable"
    ],
    "attributes": [
      "public"
    ],
    "methods": [
      "public static ai.vespa.feed.client.JsonFeeder$Builder builder(ai.vespa.feed.client.FeedClient)",
      "public java.util.concurrent.CompletableFuture feedSingle(java.lang.String)",
      "public java.util.concurrent.CompletableFuture feedMany(java.io.InputStream, ai.vespa.feed.client.JsonFeeder$ResultCallback)",
      "public java.util.concurrent.CompletableFuture feedMany(java.io.InputStream)",
      "public void close()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.OperationParameters": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public static ai.vespa.feed.client.OperationParameters empty()",
      "public ai.vespa.feed.client.OperationParameters createIfNonExistent(boolean)",
      "public ai.vespa.feed.client.OperationParameters testAndSetCondition(java.lang.String)",
      "public ai.vespa.feed.client.OperationParameters timeout(java.time.Duration)",
      "public ai.vespa.feed.client.OperationParameters route(java.lang.String)",
      "public ai.vespa.feed.client.OperationParameters tracelevel(int)",
      "public boolean createIfNonExistent()",
      "public java.util.Optional testAndSetCondition()",
      "public java.util.Optional timeout()",
      "public java.util.Optional route()",
      "public java.util.OptionalInt tracelevel()",
      "public boolean equals(java.lang.Object)",
      "public int hashCode()",
      "public java.lang.String toString()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.OperationParseException": {
    "superClass": "ai.vespa.feed.client.FeedException",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(java.lang.String)",
      "public void <init>(java.lang.String, java.lang.Throwable)"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.OperationStats": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(long, java.util.Map, long, long, long, long, long, long, long)",
      "public long requests()",
      "public long responses()",
      "public long successes()",
      "public java.util.Map responsesByCode()",
      "public long exceptions()",
      "public long inflight()",
      "public long averageLatencyMillis()",
      "public long minLatencyMillis()",
      "public long maxLatencyMillis()",
      "public long bytesSent()",
      "public long bytesReceived()",
      "public java.lang.String toString()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.Result$Type": {
    "superClass": "java.lang.Enum",
    "interfaces": [],
    "attributes": [
      "public",
      "final",
      "enum"
    ],
    "methods": [
      "public static ai.vespa.feed.client.Result$Type[] values()",
      "public static ai.vespa.feed.client.Result$Type valueOf(java.lang.String)"
    ],
    "fields": [
      "public static final enum ai.vespa.feed.client.Result$Type success",
      "public static final enum ai.vespa.feed.client.Result$Type conditionNotMet"
    ]
  },
  "ai.vespa.feed.client.Result": {
    "superClass": "java.lang.Object",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public ai.vespa.feed.client.Result$Type type()",
      "public ai.vespa.feed.client.DocumentId documentId()",
      "public java.util.Optional resultMessage()",
      "public java.util.Optional traceMessage()",
      "public java.lang.String toString()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.ResultException": {
    "superClass": "ai.vespa.feed.client.FeedException",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(ai.vespa.feed.client.DocumentId, java.lang.String, java.lang.String)",
      "public java.util.Optional getTrace()"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.ResultParseException": {
    "superClass": "ai.vespa.feed.client.FeedException",
    "interfaces": [],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(ai.vespa.feed.client.DocumentId, java.lang.String)",
      "public void <init>(ai.vespa.feed.client.DocumentId, java.lang.Throwable)"
    ],
    "fields": []
  },
  "ai.vespa.feed.client.StaticThrottler": {
    "superClass": "java.lang.Object",
    "interfaces": [
      "ai.vespa.feed.client.Throttler"
    ],
    "attributes": [
      "public"
    ],
    "methods": [
      "public void <init>(ai.vespa.feed.client.FeedClientBuilder)",
      "public void sent(long, java.util.concurrent.CompletableFuture)",
      "public void success()",
      "public void throttled(long)",
      "public long targetInflight()"
    ],
    "fields": [
      "protected final long maxInflight",
      "protected final long minInflight"
    ]
  }
}