Skip to content

Commit 4ffa1cd

Browse files
algolia-botkai687
andcommitted
fix(specs): clarify getIndexingTime (generated)
algolia/api-clients-automation#6276 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Kai Welke <kai.welke@algolia.com>
1 parent 4ed233c commit 4ffa1cd

File tree

1 file changed

+48
-8
lines changed

1 file changed

+48
-8
lines changed

algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java

Lines changed: 48 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1191,7 +1191,12 @@ public CompletableFuture<Response> getIncidentsWithHTTPInfoAsync() throws Algoli
11911191
}
11921192

11931193
/**
1194-
* Retrieves average times for indexing operations for selected clusters.
1194+
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for
1195+
* infrastructure-level monitoring and availability checks. The returned value reflects latency
1196+
* measured on Algolia's internal monitoring index and is reported in milliseconds. This metric
1197+
* isn't intended to represent the indexing performance of an individual application or index. To
1198+
* measure when an indexing operation has completed for your application, use the `waitTask`
1199+
* method.
11951200
*
11961201
* @param clusters Subset of clusters, separated by commas. (required)
11971202
* @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -1204,7 +1209,12 @@ public IndexingTimeResponse getIndexingTime(@Nonnull String clusters, @Nullable
12041209
}
12051210

12061211
/**
1207-
* Retrieves average times for indexing operations for selected clusters.
1212+
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for
1213+
* infrastructure-level monitoring and availability checks. The returned value reflects latency
1214+
* measured on Algolia's internal monitoring index and is reported in milliseconds. This metric
1215+
* isn't intended to represent the indexing performance of an individual application or index. To
1216+
* measure when an indexing operation has completed for your application, use the `waitTask`
1217+
* method.
12081218
*
12091219
* @param clusters Subset of clusters, separated by commas. (required)
12101220
* @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -1217,7 +1227,12 @@ public Response getIndexingTimeWithHTTPInfo(@Nonnull String clusters, @Nullable
12171227
}
12181228

12191229
/**
1220-
* Retrieves average times for indexing operations for selected clusters.
1230+
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for
1231+
* infrastructure-level monitoring and availability checks. The returned value reflects latency
1232+
* measured on Algolia's internal monitoring index and is reported in milliseconds. This metric
1233+
* isn't intended to represent the indexing performance of an individual application or index. To
1234+
* measure when an indexing operation has completed for your application, use the `waitTask`
1235+
* method.
12211236
*
12221237
* @param clusters Subset of clusters, separated by commas. (required)
12231238
* @throws AlgoliaRuntimeException If it fails to process the API call
@@ -1227,7 +1242,12 @@ public IndexingTimeResponse getIndexingTime(@Nonnull String clusters) throws Alg
12271242
}
12281243

12291244
/**
1230-
* Retrieves average times for indexing operations for selected clusters.
1245+
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for
1246+
* infrastructure-level monitoring and availability checks. The returned value reflects latency
1247+
* measured on Algolia's internal monitoring index and is reported in milliseconds. This metric
1248+
* isn't intended to represent the indexing performance of an individual application or index. To
1249+
* measure when an indexing operation has completed for your application, use the `waitTask`
1250+
* method.
12311251
*
12321252
* @param clusters Subset of clusters, separated by commas. (required)
12331253
* @throws AlgoliaRuntimeException If it fails to process the API call
@@ -1237,7 +1257,12 @@ public Response getIndexingTimeWithHTTPInfo(@Nonnull String clusters) throws Alg
12371257
}
12381258

12391259
/**
1240-
* (asynchronously) Retrieves average times for indexing operations for selected clusters.
1260+
* (asynchronously) Retrieves indexing latency metrics for selected clusters. This endpoint is
1261+
* intended for infrastructure-level monitoring and availability checks. The returned value
1262+
* reflects latency measured on Algolia's internal monitoring index and is reported in
1263+
* milliseconds. This metric isn't intended to represent the indexing performance of an individual
1264+
* application or index. To measure when an indexing operation has completed for your application,
1265+
* use the `waitTask` method.
12411266
*
12421267
* @param clusters Subset of clusters, separated by commas. (required)
12431268
* @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -1254,7 +1279,12 @@ public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull Str
12541279
}
12551280

12561281
/**
1257-
* (asynchronously) Retrieves average times for indexing operations for selected clusters.
1282+
* (asynchronously) Retrieves indexing latency metrics for selected clusters. This endpoint is
1283+
* intended for infrastructure-level monitoring and availability checks. The returned value
1284+
* reflects latency measured on Algolia's internal monitoring index and is reported in
1285+
* milliseconds. This metric isn't intended to represent the indexing performance of an individual
1286+
* application or index. To measure when an indexing operation has completed for your application,
1287+
* use the `waitTask` method.
12581288
*
12591289
* @param clusters Subset of clusters, separated by commas. (required)
12601290
* @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -1271,7 +1301,12 @@ public CompletableFuture<Response> getIndexingTimeWithHTTPInfoAsync(@Nonnull Str
12711301
}
12721302

12731303
/**
1274-
* (asynchronously) Retrieves average times for indexing operations for selected clusters.
1304+
* (asynchronously) Retrieves indexing latency metrics for selected clusters. This endpoint is
1305+
* intended for infrastructure-level monitoring and availability checks. The returned value
1306+
* reflects latency measured on Algolia's internal monitoring index and is reported in
1307+
* milliseconds. This metric isn't intended to represent the indexing performance of an individual
1308+
* application or index. To measure when an indexing operation has completed for your application,
1309+
* use the `waitTask` method.
12751310
*
12761311
* @param clusters Subset of clusters, separated by commas. (required)
12771312
* @throws AlgoliaRuntimeException If it fails to process the API call
@@ -1281,7 +1316,12 @@ public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull Str
12811316
}
12821317

12831318
/**
1284-
* (asynchronously) Retrieves average times for indexing operations for selected clusters.
1319+
* (asynchronously) Retrieves indexing latency metrics for selected clusters. This endpoint is
1320+
* intended for infrastructure-level monitoring and availability checks. The returned value
1321+
* reflects latency measured on Algolia's internal monitoring index and is reported in
1322+
* milliseconds. This metric isn't intended to represent the indexing performance of an individual
1323+
* application or index. To measure when an indexing operation has completed for your application,
1324+
* use the `waitTask` method.
12851325
*
12861326
* @param clusters Subset of clusters, separated by commas. (required)
12871327
* @throws AlgoliaRuntimeException If it fails to process the API call

0 commit comments

Comments
 (0)