Skip to content

Commit 5113222

Browse files
algolia-botkai687shortcuts
committed
chore: deprecate mcm methods (generated)
algolia/api-clients-automation#4694 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: shortcuts <[email protected]>
1 parent 8cdd62a commit 5113222

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

‎algoliasearch/src/main/java/com/algolia/api/SearchClient.java

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,9 @@ public CompletableFuture<CreatedAtResponse> appendSourceAsync(@Nonnull Source so
276276
* @param requestOptions The requestOptions to send along with the query, they will be merged with
277277
* the transporter requestOptions.
278278
* @throws AlgoliaRuntimeException If it fails to process the API call
279+
* @deprecated
279280
*/
281+
@Deprecated
280282
public CreatedAtResponse assignUserId(
281283
@Nonnull String xAlgoliaUserID,
282284
@Nonnull AssignUserIdParams assignUserIdParams,
@@ -292,7 +294,9 @@ public CreatedAtResponse assignUserId(
292294
* @param xAlgoliaUserID Unique identifier of the user who makes the search request. (required)
293295
* @param assignUserIdParams (required)
294296
* @throws AlgoliaRuntimeException If it fails to process the API call
297+
* @deprecated
295298
*/
299+
@Deprecated
296300
public CreatedAtResponse assignUserId(@Nonnull String xAlgoliaUserID, @Nonnull AssignUserIdParams assignUserIdParams)
297301
throws AlgoliaRuntimeException {
298302
return this.assignUserId(xAlgoliaUserID, assignUserIdParams, null);
@@ -307,7 +311,9 @@ public CreatedAtResponse assignUserId(@Nonnull String xAlgoliaUserID, @Nonnull A
307311
* @param requestOptions The requestOptions to send along with the query, they will be merged with
308312
* the transporter requestOptions.
309313
* @throws AlgoliaRuntimeException If it fails to process the API call
314+
* @deprecated
310315
*/
316+
@Deprecated
311317
public CompletableFuture<CreatedAtResponse> assignUserIdAsync(
312318
@Nonnull String xAlgoliaUserID,
313319
@Nonnull AssignUserIdParams assignUserIdParams,
@@ -333,7 +339,9 @@ public CompletableFuture<CreatedAtResponse> assignUserIdAsync(
333339
* @param xAlgoliaUserID Unique identifier of the user who makes the search request. (required)
334340
* @param assignUserIdParams (required)
335341
* @throws AlgoliaRuntimeException If it fails to process the API call
342+
* @deprecated
336343
*/
344+
@Deprecated
337345
public CompletableFuture<CreatedAtResponse> assignUserIdAsync(
338346
@Nonnull String xAlgoliaUserID,
339347
@Nonnull AssignUserIdParams assignUserIdParams
@@ -431,7 +439,9 @@ public CompletableFuture<BatchResponse> batchAsync(@Nonnull String indexName, @N
431439
* @param requestOptions The requestOptions to send along with the query, they will be merged with
432440
* the transporter requestOptions.
433441
* @throws AlgoliaRuntimeException If it fails to process the API call
442+
* @deprecated
434443
*/
444+
@Deprecated
435445
public CreatedAtResponse batchAssignUserIds(
436446
@Nonnull String xAlgoliaUserID,
437447
@Nonnull BatchAssignUserIdsParams batchAssignUserIdsParams,
@@ -446,7 +456,9 @@ public CreatedAtResponse batchAssignUserIds(
446456
* @param xAlgoliaUserID Unique identifier of the user who makes the search request. (required)
447457
* @param batchAssignUserIdsParams (required)
448458
* @throws AlgoliaRuntimeException If it fails to process the API call
459+
* @deprecated
449460
*/
461+
@Deprecated
450462
public CreatedAtResponse batchAssignUserIds(@Nonnull String xAlgoliaUserID, @Nonnull BatchAssignUserIdsParams batchAssignUserIdsParams)
451463
throws AlgoliaRuntimeException {
452464
return this.batchAssignUserIds(xAlgoliaUserID, batchAssignUserIdsParams, null);
@@ -461,7 +473,9 @@ public CreatedAtResponse batchAssignUserIds(@Nonnull String xAlgoliaUserID, @Non
461473
* @param requestOptions The requestOptions to send along with the query, they will be merged with
462474
* the transporter requestOptions.
463475
* @throws AlgoliaRuntimeException If it fails to process the API call
476+
* @deprecated
464477
*/
478+
@Deprecated
465479
public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(
466480
@Nonnull String xAlgoliaUserID,
467481
@Nonnull BatchAssignUserIdsParams batchAssignUserIdsParams,
@@ -490,7 +504,9 @@ public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(
490504
* @param xAlgoliaUserID Unique identifier of the user who makes the search request. (required)
491505
* @param batchAssignUserIdsParams (required)
492506
* @throws AlgoliaRuntimeException If it fails to process the API call
507+
* @deprecated
493508
*/
509+
@Deprecated
494510
public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(
495511
@Nonnull String xAlgoliaUserID,
496512
@Nonnull BatchAssignUserIdsParams batchAssignUserIdsParams
@@ -2944,7 +2960,9 @@ public CompletableFuture<GetTaskResponse> getTaskAsync(@Nonnull String indexName
29442960
* @param requestOptions The requestOptions to send along with the query, they will be merged with
29452961
* the transporter requestOptions.
29462962
* @throws AlgoliaRuntimeException If it fails to process the API call
2963+
* @deprecated
29472964
*/
2965+
@Deprecated
29482966
public GetTopUserIdsResponse getTopUserIds(@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
29492967
return LaunderThrowable.await(getTopUserIdsAsync(requestOptions));
29502968
}
@@ -2954,7 +2972,9 @@ public GetTopUserIdsResponse getTopUserIds(@Nullable RequestOptions requestOptio
29542972
* few seconds to get the data from the different clusters, the response isn't real-time.
29552973
*
29562974
* @throws AlgoliaRuntimeException If it fails to process the API call
2975+
* @deprecated
29572976
*/
2977+
@Deprecated
29582978
public GetTopUserIdsResponse getTopUserIds() throws AlgoliaRuntimeException {
29592979
return this.getTopUserIds(null);
29602980
}
@@ -2967,7 +2987,9 @@ public GetTopUserIdsResponse getTopUserIds() throws AlgoliaRuntimeException {
29672987
* @param requestOptions The requestOptions to send along with the query, they will be merged with
29682988
* the transporter requestOptions.
29692989
* @throws AlgoliaRuntimeException If it fails to process the API call
2990+
* @deprecated
29702991
*/
2992+
@Deprecated
29712993
public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync(@Nullable RequestOptions requestOptions)
29722994
throws AlgoliaRuntimeException {
29732995
HttpRequest request = HttpRequest.builder().setPath("/1/clusters/mapping/top").setMethod("GET").build();
@@ -2981,7 +3003,9 @@ public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync(@Nullable Req
29813003
* real-time.
29823004
*
29833005
* @throws AlgoliaRuntimeException If it fails to process the API call
3006+
* @deprecated
29843007
*/
3008+
@Deprecated
29853009
public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync() throws AlgoliaRuntimeException {
29863010
return this.getTopUserIdsAsync(null);
29873011
}
@@ -2994,7 +3018,9 @@ public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync() throws Algo
29943018
* @param requestOptions The requestOptions to send along with the query, they will be merged with
29953019
* the transporter requestOptions.
29963020
* @throws AlgoliaRuntimeException If it fails to process the API call
3021+
* @deprecated
29973022
*/
3023+
@Deprecated
29983024
public UserId getUserId(@Nonnull String userID, @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
29993025
return LaunderThrowable.await(getUserIdAsync(userID, requestOptions));
30003026
}
@@ -3005,7 +3031,9 @@ public UserId getUserId(@Nonnull String userID, @Nullable RequestOptions request
30053031
*
30063032
* @param userID Unique identifier of the user who makes the search request. (required)
30073033
* @throws AlgoliaRuntimeException If it fails to process the API call
3034+
* @deprecated
30083035
*/
3036+
@Deprecated
30093037
public UserId getUserId(@Nonnull String userID) throws AlgoliaRuntimeException {
30103038
return this.getUserId(userID, null);
30113039
}
@@ -3018,7 +3046,9 @@ public UserId getUserId(@Nonnull String userID) throws AlgoliaRuntimeException {
30183046
* @param requestOptions The requestOptions to send along with the query, they will be merged with
30193047
* the transporter requestOptions.
30203048
* @throws AlgoliaRuntimeException If it fails to process the API call
3049+
* @deprecated
30213050
*/
3051+
@Deprecated
30223052
public CompletableFuture<UserId> getUserIdAsync(@Nonnull String userID, @Nullable RequestOptions requestOptions)
30233053
throws AlgoliaRuntimeException {
30243054
Parameters.requireNonNull(userID, "Parameter `userID` is required when calling `getUserId`.");
@@ -3033,7 +3063,9 @@ public CompletableFuture<UserId> getUserIdAsync(@Nonnull String userID, @Nullabl
30333063
*
30343064
* @param userID Unique identifier of the user who makes the search request. (required)
30353065
* @throws AlgoliaRuntimeException If it fails to process the API call
3066+
* @deprecated
30363067
*/
3068+
@Deprecated
30373069
public CompletableFuture<UserId> getUserIdAsync(@Nonnull String userID) throws AlgoliaRuntimeException {
30383070
return this.getUserIdAsync(userID, null);
30393071
}
@@ -3048,7 +3080,9 @@ public CompletableFuture<UserId> getUserIdAsync(@Nonnull String userID) throws A
30483080
* @param requestOptions The requestOptions to send along with the query, they will be merged with
30493081
* the transporter requestOptions.
30503082
* @throws AlgoliaRuntimeException If it fails to process the API call
3083+
* @deprecated
30513084
*/
3085+
@Deprecated
30523086
public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters, @Nullable RequestOptions requestOptions)
30533087
throws AlgoliaRuntimeException {
30543088
return LaunderThrowable.await(hasPendingMappingsAsync(getClusters, requestOptions));
@@ -3062,7 +3096,9 @@ public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters, @Nulla
30623096
* @param getClusters Whether to include the cluster's pending mapping state in the response.
30633097
* (optional)
30643098
* @throws AlgoliaRuntimeException If it fails to process the API call
3099+
* @deprecated
30653100
*/
3101+
@Deprecated
30663102
public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters) throws AlgoliaRuntimeException {
30673103
return this.hasPendingMappings(getClusters, null);
30683104
}
@@ -3101,7 +3137,9 @@ public HasPendingMappingsResponse hasPendingMappings() throws AlgoliaRuntimeExce
31013137
* @param requestOptions The requestOptions to send along with the query, they will be merged with
31023138
* the transporter requestOptions.
31033139
* @throws AlgoliaRuntimeException If it fails to process the API call
3140+
* @deprecated
31043141
*/
3142+
@Deprecated
31053143
public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync(
31063144
Boolean getClusters,
31073145
@Nullable RequestOptions requestOptions
@@ -3122,7 +3160,9 @@ public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync(
31223160
* @param getClusters Whether to include the cluster's pending mapping state in the response.
31233161
* (optional)
31243162
* @throws AlgoliaRuntimeException If it fails to process the API call
3163+
* @deprecated
31253164
*/
3165+
@Deprecated
31263166
public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync(Boolean getClusters) throws AlgoliaRuntimeException {
31273167
return this.hasPendingMappingsAsync(getClusters, null);
31283168
}
@@ -3204,7 +3244,9 @@ public CompletableFuture<ListApiKeysResponse> listApiKeysAsync() throws AlgoliaR
32043244
* @param requestOptions The requestOptions to send along with the query, they will be merged with
32053245
* the transporter requestOptions.
32063246
* @throws AlgoliaRuntimeException If it fails to process the API call
3247+
* @deprecated
32073248
*/
3249+
@Deprecated
32083250
public ListClustersResponse listClusters(@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
32093251
return LaunderThrowable.await(listClustersAsync(requestOptions));
32103252
}
@@ -3213,7 +3255,9 @@ public ListClustersResponse listClusters(@Nullable RequestOptions requestOptions
32133255
* Lists the available clusters in a multi-cluster setup.
32143256
*
32153257
* @throws AlgoliaRuntimeException If it fails to process the API call
3258+
* @deprecated
32163259
*/
3260+
@Deprecated
32173261
public ListClustersResponse listClusters() throws AlgoliaRuntimeException {
32183262
return this.listClusters(null);
32193263
}
@@ -3224,7 +3268,9 @@ public ListClustersResponse listClusters() throws AlgoliaRuntimeException {
32243268
* @param requestOptions The requestOptions to send along with the query, they will be merged with
32253269
* the transporter requestOptions.
32263270
* @throws AlgoliaRuntimeException If it fails to process the API call
3271+
* @deprecated
32273272
*/
3273+
@Deprecated
32283274
public CompletableFuture<ListClustersResponse> listClustersAsync(@Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
32293275
HttpRequest request = HttpRequest.builder().setPath("/1/clusters").setMethod("GET").build();
32303276

@@ -3235,7 +3281,9 @@ public CompletableFuture<ListClustersResponse> listClustersAsync(@Nullable Reque
32353281
* (asynchronously) Lists the available clusters in a multi-cluster setup.
32363282
*
32373283
* @throws AlgoliaRuntimeException If it fails to process the API call
3284+
* @deprecated
32383285
*/
3286+
@Deprecated
32393287
public CompletableFuture<ListClustersResponse> listClustersAsync() throws AlgoliaRuntimeException {
32403288
return this.listClustersAsync(null);
32413289
}
@@ -3361,7 +3409,9 @@ public CompletableFuture<ListIndicesResponse> listIndicesAsync() throws AlgoliaR
33613409
* @param requestOptions The requestOptions to send along with the query, they will be merged with
33623410
* the transporter requestOptions.
33633411
* @throws AlgoliaRuntimeException If it fails to process the API call
3412+
* @deprecated
33643413
*/
3414+
@Deprecated
33653415
public ListUserIdsResponse listUserIds(Integer page, Integer hitsPerPage, @Nullable RequestOptions requestOptions)
33663416
throws AlgoliaRuntimeException {
33673417
return LaunderThrowable.await(listUserIdsAsync(page, hitsPerPage, requestOptions));
@@ -3375,7 +3425,9 @@ public ListUserIdsResponse listUserIds(Integer page, Integer hitsPerPage, @Nulla
33753425
* (optional)
33763426
* @param hitsPerPage Number of hits per page. (optional, default to 100)
33773427
* @throws AlgoliaRuntimeException If it fails to process the API call
3428+
* @deprecated
33783429
*/
3430+
@Deprecated
33793431
public ListUserIdsResponse listUserIds(Integer page, Integer hitsPerPage) throws AlgoliaRuntimeException {
33803432
return this.listUserIds(page, hitsPerPage, null);
33813433
}
@@ -3412,7 +3464,9 @@ public ListUserIdsResponse listUserIds() throws AlgoliaRuntimeException {
34123464
* @param requestOptions The requestOptions to send along with the query, they will be merged with
34133465
* the transporter requestOptions.
34143466
* @throws AlgoliaRuntimeException If it fails to process the API call
3467+
* @deprecated
34153468
*/
3469+
@Deprecated
34163470
public CompletableFuture<ListUserIdsResponse> listUserIdsAsync(
34173471
Integer page,
34183472
Integer hitsPerPage,
@@ -3435,7 +3489,9 @@ public CompletableFuture<ListUserIdsResponse> listUserIdsAsync(
34353489
* (optional)
34363490
* @param hitsPerPage Number of hits per page. (optional, default to 100)
34373491
* @throws AlgoliaRuntimeException If it fails to process the API call
3492+
* @deprecated
34383493
*/
3494+
@Deprecated
34393495
public CompletableFuture<ListUserIdsResponse> listUserIdsAsync(Integer page, Integer hitsPerPage) throws AlgoliaRuntimeException {
34403496
return this.listUserIdsAsync(page, hitsPerPage, null);
34413497
}
@@ -4025,7 +4081,9 @@ public CompletableFuture<UpdatedAtWithObjectIdResponse> partialUpdateObjectAsync
40254081
* @param requestOptions The requestOptions to send along with the query, they will be merged with
40264082
* the transporter requestOptions.
40274083
* @throws AlgoliaRuntimeException If it fails to process the API call
4084+
* @deprecated
40284085
*/
4086+
@Deprecated
40294087
public RemoveUserIdResponse removeUserId(@Nonnull String userID, @Nullable RequestOptions requestOptions) throws AlgoliaRuntimeException {
40304088
return LaunderThrowable.await(removeUserIdAsync(userID, requestOptions));
40314089
}
@@ -4035,7 +4093,9 @@ public RemoveUserIdResponse removeUserId(@Nonnull String userID, @Nullable Reque
40354093
*
40364094
* @param userID Unique identifier of the user who makes the search request. (required)
40374095
* @throws AlgoliaRuntimeException If it fails to process the API call
4096+
* @deprecated
40384097
*/
4098+
@Deprecated
40394099
public RemoveUserIdResponse removeUserId(@Nonnull String userID) throws AlgoliaRuntimeException {
40404100
return this.removeUserId(userID, null);
40414101
}
@@ -4047,7 +4107,9 @@ public RemoveUserIdResponse removeUserId(@Nonnull String userID) throws AlgoliaR
40474107
* @param requestOptions The requestOptions to send along with the query, they will be merged with
40484108
* the transporter requestOptions.
40494109
* @throws AlgoliaRuntimeException If it fails to process the API call
4110+
* @deprecated
40504111
*/
4112+
@Deprecated
40514113
public CompletableFuture<RemoveUserIdResponse> removeUserIdAsync(@Nonnull String userID, @Nullable RequestOptions requestOptions)
40524114
throws AlgoliaRuntimeException {
40534115
Parameters.requireNonNull(userID, "Parameter `userID` is required when calling `removeUserId`.");
@@ -4061,7 +4123,9 @@ public CompletableFuture<RemoveUserIdResponse> removeUserIdAsync(@Nonnull String
40614123
*
40624124
* @param userID Unique identifier of the user who makes the search request. (required)
40634125
* @throws AlgoliaRuntimeException If it fails to process the API call
4126+
* @deprecated
40644127
*/
4128+
@Deprecated
40654129
public CompletableFuture<RemoveUserIdResponse> removeUserIdAsync(@Nonnull String userID) throws AlgoliaRuntimeException {
40664130
return this.removeUserIdAsync(userID, null);
40674131
}
@@ -5650,7 +5714,9 @@ public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull St
56505714
* @param requestOptions The requestOptions to send along with the query, they will be merged with
56515715
* the transporter requestOptions.
56525716
* @throws AlgoliaRuntimeException If it fails to process the API call
5717+
* @deprecated
56535718
*/
5719+
@Deprecated
56545720
public SearchUserIdsResponse searchUserIds(@Nonnull SearchUserIdsParams searchUserIdsParams, @Nullable RequestOptions requestOptions)
56555721
throws AlgoliaRuntimeException {
56565722
return LaunderThrowable.await(searchUserIdsAsync(searchUserIdsParams, requestOptions));
@@ -5665,7 +5731,9 @@ public SearchUserIdsResponse searchUserIds(@Nonnull SearchUserIdsParams searchUs
56655731
*
56665732
* @param searchUserIdsParams (required)
56675733
* @throws AlgoliaRuntimeException If it fails to process the API call
5734+
* @deprecated
56685735
*/
5736+
@Deprecated
56695737
public SearchUserIdsResponse searchUserIds(@Nonnull SearchUserIdsParams searchUserIdsParams) throws AlgoliaRuntimeException {
56705738
return this.searchUserIds(searchUserIdsParams, null);
56715739
}
@@ -5681,7 +5749,9 @@ public SearchUserIdsResponse searchUserIds(@Nonnull SearchUserIdsParams searchUs
56815749
* @param requestOptions The requestOptions to send along with the query, they will be merged with
56825750
* the transporter requestOptions.
56835751
* @throws AlgoliaRuntimeException If it fails to process the API call
5752+
* @deprecated
56845753
*/
5754+
@Deprecated
56855755
public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(
56865756
@Nonnull SearchUserIdsParams searchUserIdsParams,
56875757
@Nullable RequestOptions requestOptions
@@ -5706,7 +5776,9 @@ public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(
57065776
*
57075777
* @param searchUserIdsParams (required)
57085778
* @throws AlgoliaRuntimeException If it fails to process the API call
5779+
* @deprecated
57095780
*/
5781+
@Deprecated
57105782
public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(@Nonnull SearchUserIdsParams searchUserIdsParams)
57115783
throws AlgoliaRuntimeException {
57125784
return this.searchUserIdsAsync(searchUserIdsParams, null);

0 commit comments

Comments
 (0)