From 3759f4f3dcb3ff401f8f50d2ec2a7062bda4c0b7 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 29 Jan 2024 17:21:56 +0000 Subject: [PATCH] test(csharp): add retry strategy https://github.com/algolia/api-clients-automation/pull/2629 Co-authored-by: Morgan Leroi --- algoliasearch/build.gradle | 4 + .../java/com/algolia/api/AbtestingClient.java | 24 +- .../java/com/algolia/api/AnalyticsClient.java | 112 +++--- .../java/com/algolia/api/InsightsClient.java | 4 +- .../com/algolia/api/MonitoringClient.java | 8 +- .../java/com/algolia/api/RecommendClient.java | 4 +- .../java/com/algolia/api/SearchClient.java | 334 +++++++++--------- .../com/algolia/model/insights/Discount.java | 8 +- .../com/algolia/model/insights/Price.java | 8 +- .../com/algolia/model/insights/Value.java | 8 +- .../model/querysuggestions/Languages.java | 8 +- .../model/recommend/AroundPrecision.java | 8 +- .../algolia/model/recommend/AroundRadius.java | 4 +- .../recommend/AutomaticFacetFilters.java | 8 +- .../model/recommend/ConsequenceQuery.java | 4 +- .../com/algolia/model/recommend/Distinct.java | 8 +- .../algolia/model/recommend/FacetFilters.java | 8 +- .../model/recommend/HighlightResult.java | 4 +- .../model/recommend/IgnorePlurals.java | 8 +- .../model/recommend/MixedSearchFilters.java | 8 +- .../model/recommend/NumericFilters.java | 8 +- .../model/recommend/OptionalFilters.java | 8 +- .../model/recommend/ReRankingApplyFilter.java | 8 +- .../model/recommend/RecommendationsHit.java | 4 +- .../model/recommend/RemoveStopWords.java | 8 +- .../model/recommend/SnippetResult.java | 4 +- .../algolia/model/recommend/TagFilters.java | 8 +- .../model/recommend/TypoTolerance.java | 4 +- .../algolia/model/search/AroundPrecision.java | 8 +- .../algolia/model/search/AroundRadius.java | 4 +- .../model/search/AttributeToUpdate.java | 4 +- .../model/search/AutomaticFacetFilters.java | 8 +- .../model/search/ConsequenceQuery.java | 4 +- .../com/algolia/model/search/Distinct.java | 8 +- .../algolia/model/search/FacetFilters.java | 8 +- .../algolia/model/search/HighlightResult.java | 4 +- .../algolia/model/search/IgnorePlurals.java | 8 +- .../model/search/MixedSearchFilters.java | 8 +- .../algolia/model/search/NumericFilters.java | 8 +- .../algolia/model/search/OptionalFilters.java | 8 +- .../model/search/ReRankingApplyFilter.java | 8 +- .../algolia/model/search/RemoveStopWords.java | 8 +- .../algolia/model/search/SnippetResult.java | 4 +- .../com/algolia/model/search/TagFilters.java | 8 +- .../algolia/model/search/TypoTolerance.java | 4 +- 45 files changed, 366 insertions(+), 380 deletions(-) diff --git a/algoliasearch/build.gradle b/algoliasearch/build.gradle index a8a839582..bbfdc98a6 100644 --- a/algoliasearch/build.gradle +++ b/algoliasearch/build.gradle @@ -27,3 +27,7 @@ tasks.withType(JavaCompile) { options.encoding = 'UTF-8' options.compilerArgs += ['-Xlint:deprecation', '-Xlint:unchecked', '-Xlint:cast', '-Xlint:rawtypes'] } + +javadoc { + options.encoding = 'UTF-8' +} diff --git a/algoliasearch/src/main/java/com/algolia/api/AbtestingClient.java b/algoliasearch/src/main/java/com/algolia/api/AbtestingClient.java index 89af9c182..ccd0ad22e 100644 --- a/algoliasearch/src/main/java/com/algolia/api/AbtestingClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/AbtestingClient.java @@ -552,8 +552,8 @@ public ABTestResponse deleteABTest(@Nonnull Integer id) throws AlgoliaRuntimeExc } /** - * (asynchronously) Delete an A/B test. To determine the `id` for an A/B test, use the - * [`listABTests` operation](#tag/abtest/operation/listABTests). + * (asynchronously) Delete an A/B test. To determine the `id` for an A/B test, use the + * [`listABTests` operation](#tag/abtest/operation/listABTests). * * @param id Unique A/B test ID. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -570,8 +570,8 @@ public CompletableFuture deleteABTestAsync(@Nonnull Integer id, } /** - * (asynchronously) Delete an A/B test. To determine the `id` for an A/B test, use the - * [`listABTests` operation](#tag/abtest/operation/listABTests). + * (asynchronously) Delete an A/B test. To determine the `id` for an A/B test, use the + * [`listABTests` operation](#tag/abtest/operation/listABTests). * * @param id Unique A/B test ID. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -605,8 +605,8 @@ public ABTest getABTest(@Nonnull Integer id) throws AlgoliaRuntimeException { } /** - * (asynchronously) Get specific details for an A/B test. To determine the `id` for an - * A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + * (asynchronously) Get specific details for an A/B test. To determine the `id` for an A/B test, + * use the [`listABTests` operation](#tag/abtest/operation/listABTests). * * @param id Unique A/B test ID. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -622,8 +622,8 @@ public CompletableFuture getABTestAsync(@Nonnull Integer id, RequestOpti } /** - * (asynchronously) Get specific details for an A/B test. To determine the `id` for an - * A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests). + * (asynchronously) Get specific details for an A/B test. To determine the `id` for an A/B test, + * use the [`listABTests` operation](#tag/abtest/operation/listABTests). * * @param id Unique A/B test ID. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -782,9 +782,9 @@ public ABTestResponse stopABTest(@Nonnull Integer id) throws AlgoliaRuntimeExcep } /** - * (asynchronously) If stopped, the test is over and can't be restarted. There is now only one + * (asynchronously) If stopped, the test is over and can't be restarted. There is now only one * index, receiving 100% of all search requests. The data gathered for stopped A/B tests is - * retained. To determine the `id` for an A/B test, use the [`listABTests` + * retained. To determine the `id` for an A/B test, use the [`listABTests` * operation](#tag/abtest/operation/listABTests). * * @param id Unique A/B test ID. (required) @@ -802,9 +802,9 @@ public CompletableFuture stopABTestAsync(@Nonnull Integer id, Re } /** - * (asynchronously) If stopped, the test is over and can't be restarted. There is now only one + * (asynchronously) If stopped, the test is over and can't be restarted. There is now only one * index, receiving 100% of all search requests. The data gathered for stopped A/B tests is - * retained. To determine the `id` for an A/B test, use the [`listABTests` + * retained. To determine the `id` for an A/B test, use the [`listABTests` * operation](#tag/abtest/operation/listABTests). * * @param id Unique A/B test ID. (required) diff --git a/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java b/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java index b9e7d0863..5f6070992 100644 --- a/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java @@ -560,10 +560,9 @@ public GetAverageClickPositionResponse getAverageClickPosition(@Nonnull String i /** * (asynchronously) Return the average click position for the complete time range and for - * individual days. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means + * Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search + * request where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -601,10 +600,9 @@ public CompletableFuture getAverageClickPositio /** * (asynchronously) Return the average click position for the complete time range and for - * individual days. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means + * Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search + * request where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -628,10 +626,9 @@ public CompletableFuture getAverageClickPositio /** * (asynchronously) Return the average click position for the complete time range and for - * individual days. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means + * Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search + * request where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -647,10 +644,9 @@ public CompletableFuture getAverageClickPositio /** * (asynchronously) Return the average click position for the complete time range and for - * individual days. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means + * Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search + * request where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -741,10 +737,9 @@ public GetClickPositionsResponse getClickPositions(@Nonnull String index) throws /** * (asynchronously) Show the number of clicks events and their associated position in the search - * results. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia + * didn't receive any click events for tracked searches. A _tracked_ search is a search request + * where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -782,10 +777,9 @@ public CompletableFuture getClickPositionsAsync( /** * (asynchronously) Show the number of clicks events and their associated position in the search - * results. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia + * didn't receive any click events for tracked searches. A _tracked_ search is a search request + * where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -809,10 +803,9 @@ public CompletableFuture getClickPositionsAsync( /** * (asynchronously) Show the number of clicks events and their associated position in the search - * results. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia + * didn't receive any click events for tracked searches. A _tracked_ search is a search request + * where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -826,10 +819,9 @@ public CompletableFuture getClickPositionsAsync(@Nonn /** * (asynchronously) Show the number of clicks events and their associated position in the search - * results. > **Note**: If all `positions` have a `clickCount` of - * `0` or `null`, it means Algolia didn't receive any click events for - * tracked searches. A _tracked_ search is a search request where the `clickAnalytics` - * parameter is `true`. + * results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia + * didn't receive any click events for tracked searches. A _tracked_ search is a search request + * where the `clickAnalytics` parameter is `true`. * * @param index Index name to target. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -1232,7 +1224,7 @@ public GetNoClickRateResponse getNoClickRate(@Nonnull String index) throws Algol } /** - * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint + * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint * returns a value for the complete given time range, as well as a value per day. It also returns * the count of searches and searches without clicks. * @@ -1271,7 +1263,7 @@ public CompletableFuture getNoClickRateAsync( } /** - * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint + * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint * returns a value for the complete given time range, as well as a value per day. It also returns * the count of searches and searches without clicks. * @@ -1296,7 +1288,7 @@ public CompletableFuture getNoClickRateAsync( } /** - * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint + * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint * returns a value for the complete given time range, as well as a value per day. It also returns * the count of searches and searches without clicks. * @@ -1311,7 +1303,7 @@ public CompletableFuture getNoClickRateAsync(@Nonnull St } /** - * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint + * (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint * returns a value for the complete given time range, as well as a value per day. It also returns * the count of searches and searches without clicks. * @@ -1390,7 +1382,7 @@ public GetNoResultsRateResponse getNoResultsRate(@Nonnull String index) throws A } /** - * (asynchronously) Returns the rate at which searches didn't return any results. + * (asynchronously) Returns the rate at which searches didn't return any results. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1427,7 +1419,7 @@ public CompletableFuture getNoResultsRateAsync( } /** - * (asynchronously) Returns the rate at which searches didn't return any results. + * (asynchronously) Returns the rate at which searches didn't return any results. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1450,7 +1442,7 @@ public CompletableFuture getNoResultsRateAsync( } /** - * (asynchronously) Returns the rate at which searches didn't return any results. + * (asynchronously) Returns the rate at which searches didn't return any results. * * @param index Index name to target. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -1463,7 +1455,7 @@ public CompletableFuture getNoResultsRateAsync(@Nonnul } /** - * (asynchronously) Returns the rate at which searches didn't return any results. + * (asynchronously) Returns the rate at which searches didn't return any results. * * @param index Index name to target. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -1705,7 +1697,7 @@ public GetSearchesNoClicksResponse getSearchesNoClicks(@Nonnull String index) th } /** - * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any + * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any * clicks. * * @param index Index name to target. (required) @@ -1750,7 +1742,7 @@ public CompletableFuture getSearchesNoClicksAsync( } /** - * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any + * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any * clicks. * * @param index Index name to target. (required) @@ -1779,7 +1771,7 @@ public CompletableFuture getSearchesNoClicksAsync( } /** - * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any + * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any * clicks. * * @param index Index name to target. (required) @@ -1793,7 +1785,7 @@ public CompletableFuture getSearchesNoClicksAsync(@ } /** - * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any + * (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any * clicks. * * @param index Index name to target. (required) @@ -1886,8 +1878,8 @@ public GetSearchesNoResultsResponse getSearchesNoResults(@Nonnull String index) } /** - * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return - * any results. + * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any + * results. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1931,8 +1923,8 @@ public CompletableFuture getSearchesNoResultsAsync } /** - * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return - * any results. + * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any + * results. * * @param index Index name to target. (required) * @param startDate Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. @@ -1960,8 +1952,8 @@ public CompletableFuture getSearchesNoResultsAsync } /** - * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return - * any results. + * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any + * results. * * @param index Index name to target. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -1974,8 +1966,8 @@ public CompletableFuture getSearchesNoResultsAsync } /** - * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return - * any results. + * (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any + * results. * * @param index Index name to target. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -2012,8 +2004,8 @@ public GetStatusResponse getStatus(@Nonnull String index) throws AlgoliaRuntimeE /** * (asynchronously) Return the latest update time of the Analytics API for an index. If the index - * has been recently created or no search has been performed yet, `updatedAt` will be - * `null`. > **Note**: The Analytics API is updated every 5 minutes. + * has been recently created or no search has been performed yet, `updatedAt` will be `null`. > + * **Note**: The Analytics API is updated every 5 minutes. * * @param index Index name to target. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -2030,8 +2022,8 @@ public CompletableFuture getStatusAsync(@Nonnull String index /** * (asynchronously) Return the latest update time of the Analytics API for an index. If the index - * has been recently created or no search has been performed yet, `updatedAt` will be - * `null`. > **Note**: The Analytics API is updated every 5 minutes. + * has been recently created or no search has been performed yet, `updatedAt` will be `null`. > + * **Note**: The Analytics API is updated every 5 minutes. * * @param index Index name to target. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -2732,7 +2724,7 @@ public GetTopFiltersNoResultsResponse getTopFiltersNoResults(@Nonnull String ind } /** - * (asynchronously) Returns top filters for filter-enabled searches that don't return results. + * (asynchronously) Returns top filters for filter-enabled searches that don't return results. * Limited to the 1,000 most recently used filters. * * @param index Index name to target. (required) @@ -2780,7 +2772,7 @@ public CompletableFuture getTopFiltersNoResultsA } /** - * (asynchronously) Returns top filters for filter-enabled searches that don't return results. + * (asynchronously) Returns top filters for filter-enabled searches that don't return results. * Limited to the 1,000 most recently used filters. * * @param index Index name to target. (required) @@ -2811,7 +2803,7 @@ public CompletableFuture getTopFiltersNoResultsA } /** - * (asynchronously) Returns top filters for filter-enabled searches that don't return results. + * (asynchronously) Returns top filters for filter-enabled searches that don't return results. * Limited to the 1,000 most recently used filters. * * @param index Index name to target. (required) @@ -2827,7 +2819,7 @@ public CompletableFuture getTopFiltersNoResultsA } /** - * (asynchronously) Returns top filters for filter-enabled searches that don't return results. + * (asynchronously) Returns top filters for filter-enabled searches that don't return results. * Limited to the 1,000 most recently used filters. * * @param index Index name to target. (required) diff --git a/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java b/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java index d9eeff5f2..34c5c82bb 100644 --- a/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/InsightsClient.java @@ -561,7 +561,7 @@ public EventsResponse pushEvents(@Nonnull InsightsEvents insightsEvents) throws /** * (asynchronously) Send a list of events to the Insights API. You can include up to 1,000 events - * in a single request, but the request body must be smaller than 2 MB. + * in a single request, but the request body must be smaller than 2 MB. * * @param insightsEvents (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -578,7 +578,7 @@ public CompletableFuture pushEventsAsync(@Nonnull InsightsEvents /** * (asynchronously) Send a list of events to the Insights API. You can include up to 1,000 events - * in a single request, but the request body must be smaller than 2 MB. + * in a single request, but the request body must be smaller than 2 MB. * * @param insightsEvents (required) * @throws AlgoliaRuntimeException If it fails to process the API call diff --git a/algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java b/algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java index 21c8e179b..557accee7 100644 --- a/algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/MonitoringClient.java @@ -669,8 +669,8 @@ public InventoryResponse getInventory() throws AlgoliaRuntimeException { /** * (asynchronously) List the servers belonging to clusters. The response depends on whether you * authenticate your API request: - With authentication, the response lists the servers assigned - * to your Algolia application's cluster. - Without authentication, the response lists the - * servers for all Algolia clusters. + * to your Algolia application's cluster. - Without authentication, the response lists the servers + * for all Algolia clusters. * * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -685,8 +685,8 @@ public CompletableFuture getInventoryAsync(RequestOptions req /** * (asynchronously) List the servers belonging to clusters. The response depends on whether you * authenticate your API request: - With authentication, the response lists the servers assigned - * to your Algolia application's cluster. - Without authentication, the response lists the - * servers for all Algolia clusters. + * to your Algolia application's cluster. - Without authentication, the response lists the servers + * for all Algolia clusters. * * @throws AlgoliaRuntimeException If it fails to process the API call */ diff --git a/algoliasearch/src/main/java/com/algolia/api/RecommendClient.java b/algoliasearch/src/main/java/com/algolia/api/RecommendClient.java index da640735b..2408ce37c 100644 --- a/algoliasearch/src/main/java/com/algolia/api/RecommendClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/RecommendClient.java @@ -680,7 +680,7 @@ public GetRecommendTaskResponse getRecommendStatus(@Nonnull String indexName, @N /** * (asynchronously) Some operations, such as deleting a Recommend rule, will respond with a - * `taskID` value. Use this value here to check the status of that task. + * `taskID` value. Use this value here to check the status of that task. * * @param indexName Index on which to perform the request. (required) * @param model [Recommend @@ -713,7 +713,7 @@ public CompletableFuture getRecommendStatusAsync( /** * (asynchronously) Some operations, such as deleting a Recommend rule, will respond with a - * `taskID` value. Use this value here to check the status of that task. + * `taskID` value. Use this value here to check the status of that task. * * @param indexName Index on which to perform the request. (required) * @param model [Recommend diff --git a/algoliasearch/src/main/java/com/algolia/api/SearchClient.java b/algoliasearch/src/main/java/com/algolia/api/SearchClient.java index 68231806e..d2afc4b8a 100644 --- a/algoliasearch/src/main/java/com/algolia/api/SearchClient.java +++ b/algoliasearch/src/main/java/com/algolia/api/SearchClient.java @@ -139,11 +139,10 @@ public UpdatedAtWithObjectIdResponse addOrUpdateObject(@Nonnull String indexName } /** - * (asynchronously) If you use an existing `objectID`, the existing record will be - * replaced with the new one. To update only some attributes of an existing record, use the - * [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add - * multiple records to your index in a single API request, use the [`batch` - * operation](#tag/Records/operation/batch). + * (asynchronously) If you use an existing `objectID`, the existing record will be replaced with + * the new one. To update only some attributes of an existing record, use the [`partial` + * operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your + * index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique record (object) identifier. (required) @@ -174,11 +173,10 @@ public CompletableFuture addOrUpdateObjectAsync( } /** - * (asynchronously) If you use an existing `objectID`, the existing record will be - * replaced with the new one. To update only some attributes of an existing record, use the - * [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add - * multiple records to your index in a single API request, use the [`batch` - * operation](#tag/Records/operation/batch). + * (asynchronously) If you use an existing `objectID`, the existing record will be replaced with + * the new one. To update only some attributes of an existing record, use the [`partial` + * operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your + * index in a single API request, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique record (object) identifier. (required) @@ -348,7 +346,7 @@ public BatchResponse batch(@Nonnull String indexName, @Nonnull BatchWriteParams /** * (asynchronously) To reduce the time spent on network round trips, you can perform several write * actions in a single API call. Actions are applied in the order they are specified. The - * supported `action`s are equivalent to the individual operations of the same name. + * supported `action`s are equivalent to the individual operations of the same name. * * @param indexName Index on which to perform the request. (required) * @param batchWriteParams (required) @@ -377,7 +375,7 @@ public CompletableFuture batchAsync( /** * (asynchronously) To reduce the time spent on network round trips, you can perform several write * actions in a single API call. Actions are applied in the order they are specified. The - * supported `action`s are equivalent to the individual operations of the same name. + * supported `action`s are equivalent to the individual operations of the same name. * * @param indexName Index on which to perform the request. (required) * @param batchWriteParams (required) @@ -418,7 +416,7 @@ public CreatedAtResponse batchAssignUserIds(@Nonnull String xAlgoliaUserID, @Non } /** - * (asynchronously) Assign multiple user IDs to a cluster. **You can't _move_ users with this + * (asynchronously) Assign multiple user IDs to a cluster. **You can't _move_ users with this * operation.**. * * @param xAlgoliaUserID userID to assign. (required) @@ -450,7 +448,7 @@ public CompletableFuture batchAssignUserIdsAsync( } /** - * (asynchronously) Assign multiple user IDs to a cluster. **You can't _move_ users with this + * (asynchronously) Assign multiple user IDs to a cluster. **You can't _move_ users with this * operation.**. * * @param xAlgoliaUserID userID to assign. (required) @@ -606,8 +604,8 @@ public BrowseResponse browse(@Nonnull String indexName, Class innerTyp /** * (asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. - * For better performance, it doesn't support: - The `distinct` query parameter - - * Sorting by typos, proximity, words, or geographical distance. + * For better performance, it doesn't support: - The `distinct` query parameter - Sorting by + * typos, proximity, words, or geographical distance. * * @param indexName Index on which to perform the request. (required) * @param browseParams (optional) @@ -635,8 +633,8 @@ public CompletableFuture> browseAsync( /** * (asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. - * For better performance, it doesn't support: - The `distinct` query parameter - - * Sorting by typos, proximity, words, or geographical distance. + * For better performance, it doesn't support: - The `distinct` query parameter - Sorting by + * typos, proximity, words, or geographical distance. * * @param indexName Index on which to perform the request. (required) * @param browseParams (optional) @@ -650,8 +648,8 @@ public CompletableFuture> browseAsync(@Nonnull String inde /** * (asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. - * For better performance, it doesn't support: - The `distinct` query parameter - - * Sorting by typos, proximity, words, or geographical distance. + * For better performance, it doesn't support: - The `distinct` query parameter - Sorting by + * typos, proximity, words, or geographical distance. * * @param indexName Index on which to perform the request. (required) * @param innerType The class held by the index, could be your custom class or {@link Object}. @@ -666,8 +664,8 @@ public CompletableFuture> browseAsync(@Nonnull String inde /** * (asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. - * For better performance, it doesn't support: - The `distinct` query parameter - - * Sorting by typos, proximity, words, or geographical distance. + * For better performance, it doesn't support: - The `distinct` query parameter - Sorting by + * typos, proximity, words, or geographical distance. * * @param indexName Index on which to perform the request. (required) * @param innerType The class held by the index, could be your custom class or {@link Object}. @@ -1445,8 +1443,8 @@ public DeletedAtResponse deleteBy(@Nonnull String indexName, @Nonnull DeleteByPa } /** - * (asynchronously) This operation doesn't support all the query options, only its filters - * (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. + * (asynchronously) This operation doesn't support all the query options, only its filters + * (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. * * @param indexName Index on which to perform the request. (required) * @param deleteByParams (required) @@ -1473,8 +1471,8 @@ public CompletableFuture deleteByAsync( } /** - * (asynchronously) This operation doesn't support all the query options, only its filters - * (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. + * (asynchronously) This operation doesn't support all the query options, only its filters + * (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries. * * @param indexName Index on which to perform the request. (required) * @param deleteByParams (required) @@ -1561,8 +1559,8 @@ public DeletedAtResponse deleteObject(@Nonnull String indexName, @Nonnull String } /** - * (asynchronously) To delete a set of records matching a query, use the - * [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead. + * (asynchronously) To delete a set of records matching a query, use the [`deleteByQuery` + * operation](#tag/Records/operation/deleteBy) instead. * * @param indexName Index on which to perform the request. (required) * @param objectID Unique record (object) identifier. (required) @@ -1588,8 +1586,8 @@ public CompletableFuture deleteObjectAsync( } /** - * (asynchronously) To delete a set of records matching a query, use the - * [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead. + * (asynchronously) To delete a set of records matching a query, use the [`deleteByQuery` + * operation](#tag/Records/operation/deleteBy) instead. * * @param indexName Index on which to perform the request. (required) * @param objectID Unique record (object) identifier. (required) @@ -1664,8 +1662,8 @@ public UpdatedAtResponse deleteRule(@Nonnull String indexName, @Nonnull String o } /** - * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` - * for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the + * [`search` operation](#tag/Rules/operation/searchRules). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a rule object. (required) @@ -1695,8 +1693,8 @@ public CompletableFuture deleteRuleAsync( } /** - * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` - * for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the + * [`search` operation](#tag/Rules/operation/searchRules). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a rule object. (required) @@ -1713,8 +1711,8 @@ public CompletableFuture deleteRuleAsync( } /** - * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` - * for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the + * [`search` operation](#tag/Rules/operation/searchRules). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a rule object. (required) @@ -1731,8 +1729,8 @@ public CompletableFuture deleteRuleAsync( } /** - * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` - * for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + * (asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the + * [`search` operation](#tag/Rules/operation/searchRules). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a rule object. (required) @@ -1855,8 +1853,8 @@ public DeletedAtResponse deleteSynonym(@Nonnull String indexName, @Nonnull Strin } /** - * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your - * synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, + * use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -1886,8 +1884,8 @@ public CompletableFuture deleteSynonymAsync( } /** - * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your - * synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, + * use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -1904,8 +1902,8 @@ public CompletableFuture deleteSynonymAsync( } /** - * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your - * synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, + * use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -1922,8 +1920,8 @@ public CompletableFuture deleteSynonymAsync( } /** - * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your - * synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + * (asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, + * use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -1963,8 +1961,8 @@ public GetApiKeyResponse getApiKey(@Nonnull String key) throws AlgoliaRuntimeExc /** * (asynchronously) Get the permissions and restrictions of a specific API key. When * authenticating with the admin API key, you can request information for any of your - * application's keys. When authenticating with other API keys, you can only retrieve - * information for that key. + * application's keys. When authenticating with other API keys, you can only retrieve information + * for that key. * * @param key API key. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -1983,8 +1981,8 @@ public CompletableFuture getApiKeyAsync(@Nonnull String key, /** * (asynchronously) Get the permissions and restrictions of a specific API key. When * authenticating with the admin API key, you can request information for any of your - * application's keys. When authenticating with other API keys, you can only retrieve - * information for that key. + * application's keys. When authenticating with other API keys, you can only retrieve information + * for that key. * * @param key API key. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -2028,9 +2026,9 @@ public Map getDictionaryLanguages() throws AlgoliaRuntimeExce } /** - * (asynchronously) Lists Algolia's [supported + * (asynchronously) Lists Algolia's [supported * languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) - * and any customizations applied to each language's [stop + * and any customizations applied to each language's [stop * word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), * [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), * and [segmentation @@ -2049,9 +2047,9 @@ public CompletableFuture> getDictionaryLanguagesAsync(Req } /** - * (asynchronously) Lists Algolia's [supported + * (asynchronously) Lists Algolia's [supported * languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) - * and any customizations applied to each language's [stop + * and any customizations applied to each language's [stop * word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), * [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), * and [segmentation @@ -2195,13 +2193,13 @@ public GetLogsResponse getLogs() throws AlgoliaRuntimeException { } /** - * (asynchronously) The request must be authenticated by an API key with the [`logs` + * (asynchronously) The request must be authenticated by an API key with the [`logs` * ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are - * held for the last seven days. There's also a logging limit of 1,000 API calls per server. - * This request counts towards your [operations + * held for the last seven days. There's also a logging limit of 1,000 API calls per server. This + * request counts towards your [operations * quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) - * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed - * Search Network (DSN) cluster, target the [DSN's + * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search + * Network (DSN) cluster, target the [DSN's * endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). * * @param offset First log entry to retrieve. Sorted by decreasing date with 0 being the most @@ -2235,13 +2233,13 @@ public CompletableFuture getLogsAsync( } /** - * (asynchronously) The request must be authenticated by an API key with the [`logs` + * (asynchronously) The request must be authenticated by an API key with the [`logs` * ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are - * held for the last seven days. There's also a logging limit of 1,000 API calls per server. - * This request counts towards your [operations + * held for the last seven days. There's also a logging limit of 1,000 API calls per server. This + * request counts towards your [operations * quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) - * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed - * Search Network (DSN) cluster, target the [DSN's + * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search + * Network (DSN) cluster, target the [DSN's * endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). * * @param offset First log entry to retrieve. Sorted by decreasing date with 0 being the most @@ -2259,13 +2257,13 @@ public CompletableFuture getLogsAsync(Integer offset, Integer l } /** - * (asynchronously) The request must be authenticated by an API key with the [`logs` + * (asynchronously) The request must be authenticated by an API key with the [`logs` * ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are - * held for the last seven days. There's also a logging limit of 1,000 API calls per server. - * This request counts towards your [operations + * held for the last seven days. There's also a logging limit of 1,000 API calls per server. This + * request counts towards your [operations * quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) - * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed - * Search Network (DSN) cluster, target the [DSN's + * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search + * Network (DSN) cluster, target the [DSN's * endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). * * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -2277,13 +2275,13 @@ public CompletableFuture getLogsAsync(RequestOptions requestOpt } /** - * (asynchronously) The request must be authenticated by an API key with the [`logs` + * (asynchronously) The request must be authenticated by an API key with the [`logs` * ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are - * held for the last seven days. There's also a logging limit of 1,000 API calls per server. - * This request counts towards your [operations + * held for the last seven days. There's also a logging limit of 1,000 API calls per server. This + * request counts towards your [operations * quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) - * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed - * Search Network (DSN) cluster, target the [DSN's + * but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search + * Network (DSN) cluster, target the [DSN's * endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers). * * @throws AlgoliaRuntimeException If it fails to process the API call @@ -2358,7 +2356,7 @@ public Map getObject(@Nonnull String indexName, @Nonnull String } /** - * (asynchronously) To get more than one record, use the [`objects` + * (asynchronously) To get more than one record, use the [`objects` * operation](#tag/Records/operation/getObjects). * * @param indexName Index on which to perform the request. (required) @@ -2392,7 +2390,7 @@ public CompletableFuture> getObjectAsync( } /** - * (asynchronously) To get more than one record, use the [`objects` + * (asynchronously) To get more than one record, use the [`objects` * operation](#tag/Records/operation/getObjects). * * @param indexName Index on which to perform the request. (required) @@ -2413,7 +2411,7 @@ public CompletableFuture> getObjectAsync( } /** - * (asynchronously) To get more than one record, use the [`objects` + * (asynchronously) To get more than one record, use the [`objects` * operation](#tag/Records/operation/getObjects). * * @param indexName Index on which to perform the request. (required) @@ -2431,7 +2429,7 @@ public CompletableFuture> getObjectAsync( } /** - * (asynchronously) To get more than one record, use the [`objects` + * (asynchronously) To get more than one record, use the [`objects` * operation](#tag/Records/operation/getObjects). * * @param indexName Index on which to perform the request. (required) @@ -2541,8 +2539,8 @@ public Rule getRule(@Nonnull String indexName, @Nonnull String objectID) throws } /** - * (asynchronously) Get a rule by its `objectID`. To find the `objectID` for - * rules, use the [`search` operation](#tag/Rules/operation/searchRules). + * (asynchronously) Get a rule by its `objectID`. To find the `objectID` for rules, use the + * [`search` operation](#tag/Rules/operation/searchRules). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a rule object. (required) @@ -2565,8 +2563,8 @@ public CompletableFuture getRuleAsync(@Nonnull String indexName, @Nonnull } /** - * (asynchronously) Get a rule by its `objectID`. To find the `objectID` for - * rules, use the [`search` operation](#tag/Rules/operation/searchRules). + * (asynchronously) Get a rule by its `objectID`. To find the `objectID` for rules, use the + * [`search` operation](#tag/Rules/operation/searchRules). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a rule object. (required) @@ -2601,7 +2599,7 @@ public IndexSettings getSettings(@Nonnull String indexName) throws AlgoliaRuntim } /** - * (asynchronously) Return an object containing an index's [configuration + * (asynchronously) Return an object containing an index's [configuration * settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). * * @param indexName Index on which to perform the request. (required) @@ -2618,7 +2616,7 @@ public CompletableFuture getSettingsAsync(@Nonnull String indexNa } /** - * (asynchronously) Return an object containing an index's [configuration + * (asynchronously) Return an object containing an index's [configuration * settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). * * @param indexName Index on which to perform the request. (required) @@ -2698,8 +2696,8 @@ public SynonymHit getSynonym(@Nonnull String indexName, @Nonnull String objectID } /** - * (asynchronously) Get a syonym by its `objectID`. To find the object IDs for your - * synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + * (asynchronously) Get a syonym by its `objectID`. To find the object IDs for your synonyms, use + * the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -2722,8 +2720,8 @@ public CompletableFuture getSynonymAsync(@Nonnull String indexName, } /** - * (asynchronously) Get a syonym by its `objectID`. To find the object IDs for your - * synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + * (asynchronously) Get a syonym by its `objectID`. To find the object IDs for your synonyms, use + * the [`search` operation](#tag/Synonyms/operation/searchSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -2761,8 +2759,8 @@ public GetTaskResponse getTask(@Nonnull String indexName, @Nonnull Long taskID) } /** - * (asynchronously) Some operations, such as copying an index, will respond with a - * `taskID` value. Use this value here to check the status of that task. + * (asynchronously) Some operations, such as copying an index, will respond with a `taskID` value. + * Use this value here to check the status of that task. * * @param indexName Index on which to perform the request. (required) * @param taskID Unique task identifier. (required) @@ -2781,8 +2779,8 @@ public CompletableFuture getTaskAsync(@Nonnull String indexName } /** - * (asynchronously) Some operations, such as copying an index, will respond with a - * `taskID` value. Use this value here to check the status of that task. + * (asynchronously) Some operations, such as copying an index, will respond with a `taskID` value. + * Use this value here to check the status of that task. * * @param indexName Index on which to perform the request. (required) * @param taskID Unique task identifier. (required) @@ -2817,7 +2815,7 @@ public GetTopUserIdsResponse getTopUserIds() throws AlgoliaRuntimeException { /** * (asynchronously) Get the IDs of the 10 users with the highest number of records per cluster. * Since it can take up to a few seconds to get the data from the different clusters, the response - * isn't real-time. + * isn't real-time. * * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -2832,7 +2830,7 @@ public CompletableFuture getTopUserIdsAsync(RequestOption /** * (asynchronously) Get the IDs of the 10 users with the highest number of records per cluster. * Since it can take up to a few seconds to get the data from the different clusters, the response - * isn't real-time. + * isn't real-time. * * @throws AlgoliaRuntimeException If it fails to process the API call */ @@ -2866,7 +2864,7 @@ public UserId getUserId(@Nonnull String userID) throws AlgoliaRuntimeException { /** * (asynchronously) Returns the userID data stored in the mapping. Since it can take up to a few - * seconds to get the data from the different clusters, the response isn't real-time. + * seconds to get the data from the different clusters, the response isn't real-time. * * @param userID userID to assign. (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -2882,7 +2880,7 @@ public CompletableFuture getUserIdAsync(@Nonnull String userID, RequestO /** * (asynchronously) Returns the userID data stored in the mapping. Since it can take up to a few - * seconds to get the data from the different clusters, the response isn't real-time. + * seconds to get the data from the different clusters, the response isn't real-time. * * @param userID userID to assign. (required) * @throws AlgoliaRuntimeException If it fails to process the API call @@ -3249,7 +3247,7 @@ public ListUserIdsResponse listUserIds() throws AlgoliaRuntimeException { /** * (asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up - * to a few seconds to get the data from the different clusters, the response isn't real-time. + * to a few seconds to get the data from the different clusters, the response isn't real-time. * * @param page Returns the requested page number. The page size is determined by the `hitsPerPage` * parameter. You can see the number of available pages in the `nbPages` response attribute. @@ -3273,7 +3271,7 @@ public CompletableFuture listUserIdsAsync(Integer page, Int /** * (asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up - * to a few seconds to get the data from the different clusters, the response isn't real-time. + * to a few seconds to get the data from the different clusters, the response isn't real-time. * * @param page Returns the requested page number. The page size is determined by the `hitsPerPage` * parameter. You can see the number of available pages in the `nbPages` response attribute. @@ -3287,7 +3285,7 @@ public CompletableFuture listUserIdsAsync(Integer page, Int /** * (asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up - * to a few seconds to get the data from the different clusters, the response isn't real-time. + * to a few seconds to get the data from the different clusters, the response isn't real-time. * * @param requestOptions The requestOptions to send along with the query, they will be merged with * the transporter requestOptions. @@ -3299,7 +3297,7 @@ public CompletableFuture listUserIdsAsync(RequestOptions re /** * (asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up - * to a few seconds to get the data from the different clusters, the response isn't real-time. + * to a few seconds to get the data from the different clusters, the response isn't real-time. * * @throws AlgoliaRuntimeException If it fails to process the API call */ @@ -3338,7 +3336,7 @@ public MultipleBatchResponse multipleBatch(@Nonnull BatchParams batchParams) thr /** * (asynchronously) To reduce the time spent on network round trips, you can perform several write - * actions in a single request. It's a multi-index version of the [`batch` + * actions in a single request. It's a multi-index version of the [`batch` * operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. * The supported actions are equivalent to the individual operations of the same name. * @@ -3357,7 +3355,7 @@ public CompletableFuture multipleBatchAsync(@Nonnull Batc /** * (asynchronously) To reduce the time spent on network round trips, you can perform several write - * actions in a single request. It's a multi-index version of the [`batch` + * actions in a single request. It's a multi-index version of the [`batch` * operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. * The supported actions are equivalent to the individual operations of the same name. * @@ -3416,14 +3414,13 @@ public UpdatedAtResponse operationIndex(@Nonnull String indexName, @Nonnull Oper } /** - * (asynchronously) This `operation`, _copy_ or _move_, will copy or move a source - * index's (`IndexName`) records, settings, synonyms, and rules to a - * `destination` index. If the destination index exists, it will be replaced, except for - * index-specific API keys and analytics data. If the destination index doesn't exist, it will - * be created. The choice between moving or copying an index depends on your needs. Choose: - - * **Move** to rename an index. - **Copy** to create a new index with the same records and - * configuration as an existing one. > **Note**: When considering copying or moving, be aware - * of the [rate + * (asynchronously) This `operation`, _copy_ or _move_, will copy or move a source index's + * (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the + * destination index exists, it will be replaced, except for index-specific API keys and analytics + * data. If the destination index doesn't exist, it will be created. The choice between moving or + * copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to + * create a new index with the same records and configuration as an existing one. > **Note**: When + * considering copying or moving, be aware of the [rate * limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) * on these processes and the [impact on your analytics * data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/). @@ -3453,14 +3450,13 @@ public CompletableFuture operationIndexAsync( } /** - * (asynchronously) This `operation`, _copy_ or _move_, will copy or move a source - * index's (`IndexName`) records, settings, synonyms, and rules to a - * `destination` index. If the destination index exists, it will be replaced, except for - * index-specific API keys and analytics data. If the destination index doesn't exist, it will - * be created. The choice between moving or copying an index depends on your needs. Choose: - - * **Move** to rename an index. - **Copy** to create a new index with the same records and - * configuration as an existing one. > **Note**: When considering copying or moving, be aware - * of the [rate + * (asynchronously) This `operation`, _copy_ or _move_, will copy or move a source index's + * (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the + * destination index exists, it will be replaced, except for index-specific API keys and analytics + * data. If the destination index doesn't exist, it will be created. The choice between moving or + * copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to + * create a new index with the same records and configuration as an existing one. > **Note**: When + * considering copying or moving, be aware of the [rate * limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) * on these processes and the [impact on your analytics * data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/). @@ -3846,11 +3842,10 @@ public SaveObjectResponse saveObject(@Nonnull String indexName, @Nonnull Object } /** - * (asynchronously) Add a record (object) to an index or replace it. If the record doesn't - * contain an `objectID`, Algolia automatically adds it. If you use an existing - * `objectID`, the existing record is replaced with the new one. To add multiple records - * to your index in a single API request, use the [`batch` - * operation](#tag/Records/operation/batch). + * (asynchronously) Add a record (object) to an index or replace it. If the record doesn't contain + * an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing + * record is replaced with the new one. To add multiple records to your index in a single API + * request, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Index on which to perform the request. (required) * @param body The Algolia record. (required) @@ -3872,11 +3867,10 @@ public CompletableFuture saveObjectAsync( } /** - * (asynchronously) Add a record (object) to an index or replace it. If the record doesn't - * contain an `objectID`, Algolia automatically adds it. If you use an existing - * `objectID`, the existing record is replaced with the new one. To add multiple records - * to your index in a single API request, use the [`batch` - * operation](#tag/Records/operation/batch). + * (asynchronously) Add a record (object) to an index or replace it. If the record doesn't contain + * an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing + * record is replaced with the new one. To add multiple records to your index in a single API + * request, use the [`batch` operation](#tag/Records/operation/batch). * * @param indexName Index on which to perform the request. (required) * @param body The Algolia record. (required) @@ -3961,7 +3955,7 @@ public UpdatedRuleResponse saveRule(@Nonnull String indexName, @Nonnull String o } /** - * (asynchronously) To create or update more than one rule, use the [`batch` + * (asynchronously) To create or update more than one rule, use the [`batch` * operation](#tag/Rules/operation/saveRules). * * @param indexName Index on which to perform the request. (required) @@ -3997,7 +3991,7 @@ public CompletableFuture saveRuleAsync( } /** - * (asynchronously) To create or update more than one rule, use the [`batch` + * (asynchronously) To create or update more than one rule, use the [`batch` * operation](#tag/Rules/operation/saveRules). * * @param indexName Index on which to perform the request. (required) @@ -4017,7 +4011,7 @@ public CompletableFuture saveRuleAsync( } /** - * (asynchronously) To create or update more than one rule, use the [`batch` + * (asynchronously) To create or update more than one rule, use the [`batch` * operation](#tag/Rules/operation/saveRules). * * @param indexName Index on which to perform the request. (required) @@ -4037,7 +4031,7 @@ public CompletableFuture saveRuleAsync( } /** - * (asynchronously) To create or update more than one rule, use the [`batch` + * (asynchronously) To create or update more than one rule, use the [`batch` * operation](#tag/Rules/operation/saveRules). * * @param indexName Index on which to perform the request. (required) @@ -4298,10 +4292,10 @@ public SaveSynonymResponse saveSynonym(@Nonnull String indexName, @Nonnull Strin /** * (asynchronously) Add a * [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) - * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds - * a new one. If you use an existing synonym `objectID`, the existing synonym is - * replaced with the new one. To add multiple synonyms in a single API request, use the - * [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If + * you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To + * add multiple synonyms in a single API request, use the [`batch` + * operation](#tag/Synonyms/operation/saveSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -4338,10 +4332,10 @@ public CompletableFuture saveSynonymAsync( /** * (asynchronously) Add a * [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) - * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds - * a new one. If you use an existing synonym `objectID`, the existing synonym is - * replaced with the new one. To add multiple synonyms in a single API request, use the - * [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If + * you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To + * add multiple synonyms in a single API request, use the [`batch` + * operation](#tag/Synonyms/operation/saveSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -4362,10 +4356,10 @@ public CompletableFuture saveSynonymAsync( /** * (asynchronously) Add a * [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) - * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds - * a new one. If you use an existing synonym `objectID`, the existing synonym is - * replaced with the new one. To add multiple synonyms in a single API request, use the - * [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If + * you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To + * add multiple synonyms in a single API request, use the [`batch` + * operation](#tag/Synonyms/operation/saveSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -4386,10 +4380,10 @@ public CompletableFuture saveSynonymAsync( /** * (asynchronously) Add a * [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) - * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds - * a new one. If you use an existing synonym `objectID`, the existing synonym is - * replaced with the new one. To add multiple synonyms in a single API request, use the - * [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + * to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If + * you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To + * add multiple synonyms in a single API request, use the [`batch` + * operation](#tag/Synonyms/operation/saveSynonyms). * * @param indexName Index on which to perform the request. (required) * @param objectID Unique identifier of a synonym object. (required) @@ -4808,12 +4802,11 @@ public SearchForFacetValuesResponse searchForFacetValues(@Nonnull String indexNa } /** - * (asynchronously) [Search for a facet's + * (asynchronously) [Search for a facet's * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), * optionally restricting the returned values to those contained in records matching other search - * criteria. > **Note**: Pagination isn't supported (`page` and - * `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but - * you can adjust this with `maxFacetHits`. + * criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By + * default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. * * @param indexName Index on which to perform the request. (required) * @param facetName Facet name. (required) @@ -4843,12 +4836,11 @@ public CompletableFuture searchForFacetValuesAsync } /** - * (asynchronously) [Search for a facet's + * (asynchronously) [Search for a facet's * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), * optionally restricting the returned values to those contained in records matching other search - * criteria. > **Note**: Pagination isn't supported (`page` and - * `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but - * you can adjust this with `maxFacetHits`. + * criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By + * default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. * * @param indexName Index on which to perform the request. (required) * @param facetName Facet name. (required) @@ -4864,12 +4856,11 @@ public CompletableFuture searchForFacetValuesAsync } /** - * (asynchronously) [Search for a facet's + * (asynchronously) [Search for a facet's * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), * optionally restricting the returned values to those contained in records matching other search - * criteria. > **Note**: Pagination isn't supported (`page` and - * `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but - * you can adjust this with `maxFacetHits`. + * criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By + * default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. * * @param indexName Index on which to perform the request. (required) * @param facetName Facet name. (required) @@ -4886,12 +4877,11 @@ public CompletableFuture searchForFacetValuesAsync } /** - * (asynchronously) [Search for a facet's + * (asynchronously) [Search for a facet's * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), * optionally restricting the returned values to those contained in records matching other search - * criteria. > **Note**: Pagination isn't supported (`page` and - * `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but - * you can adjust this with `maxFacetHits`. + * criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By + * default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`. * * @param indexName Index on which to perform the request. (required) * @param facetName Facet name. (required) @@ -5303,10 +5293,10 @@ public SearchUserIdsResponse searchUserIds(@Nonnull SearchUserIdsParams searchUs /** * (asynchronously) Since it can take up to a few seconds to get the data from the different - * clusters, the response isn't real-time. To ensure rapid updates, the user IDs index - * isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the - * same time as the update of user ID usage. For example, if you add or move a user ID, the search - * will show an old value until the next time the mapping is rebuilt (every 12 hours). + * clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built + * at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the + * update of user ID usage. For example, if you add or move a user ID, the search will show an old + * value until the next time the mapping is rebuilt (every 12 hours). * * @param searchUserIdsParams (required) * @param requestOptions The requestOptions to send along with the query, they will be merged with @@ -5331,10 +5321,10 @@ public CompletableFuture searchUserIdsAsync( /** * (asynchronously) Since it can take up to a few seconds to get the data from the different - * clusters, the response isn't real-time. To ensure rapid updates, the user IDs index - * isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the - * same time as the update of user ID usage. For example, if you add or move a user ID, the search - * will show an old value until the next time the mapping is rebuilt (every 12 hours). + * clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built + * at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the + * update of user ID usage. For example, if you add or move a user ID, the search will show an old + * value until the next time the mapping is rebuilt (every 12 hours). * * @param searchUserIdsParams (required) * @throws AlgoliaRuntimeException If it fails to process the API call diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/Discount.java b/algoliasearch/src/main/java/com/algolia/model/insights/Discount.java index 145b1e920..3a5f37090 100644 --- a/algoliasearch/src/main/java/com/algolia/model/insights/Discount.java +++ b/algoliasearch/src/main/java/com/algolia/model/insights/Discount.java @@ -14,17 +14,17 @@ /** The absolute value of the discount for this product, in units of `currency`. */ @JsonDeserialize(using = Discount.Deserializer.class) public interface Discount { - /** Discount as Double wrapper. */ + // Discount as Double wrapper. static Discount of(Double value) { return new DoubleWrapper(value); } - /** Discount as String wrapper. */ + // Discount as String wrapper. static Discount of(String value) { return new StringWrapper(value); } - /** Discount as Double wrapper. */ + // Discount as Double wrapper. @JsonSerialize(using = DoubleWrapper.Serializer.class) class DoubleWrapper implements Discount { @@ -47,7 +47,7 @@ public void serialize(DoubleWrapper value, JsonGenerator gen, SerializerProvider } } - /** Discount as String wrapper. */ + // Discount as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements Discount { diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/Price.java b/algoliasearch/src/main/java/com/algolia/model/insights/Price.java index 4ddd50c47..1ee38d58c 100644 --- a/algoliasearch/src/main/java/com/algolia/model/insights/Price.java +++ b/algoliasearch/src/main/java/com/algolia/model/insights/Price.java @@ -14,17 +14,17 @@ /** The total price of a product, including any discounts, in units of `currency`. */ @JsonDeserialize(using = Price.Deserializer.class) public interface Price { - /** Price as Double wrapper. */ + // Price as Double wrapper. static Price of(Double value) { return new DoubleWrapper(value); } - /** Price as String wrapper. */ + // Price as String wrapper. static Price of(String value) { return new StringWrapper(value); } - /** Price as Double wrapper. */ + // Price as Double wrapper. @JsonSerialize(using = DoubleWrapper.Serializer.class) class DoubleWrapper implements Price { @@ -47,7 +47,7 @@ public void serialize(DoubleWrapper value, JsonGenerator gen, SerializerProvider } } - /** Price as String wrapper. */ + // Price as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements Price { diff --git a/algoliasearch/src/main/java/com/algolia/model/insights/Value.java b/algoliasearch/src/main/java/com/algolia/model/insights/Value.java index 03dc8311d..c9ed40d34 100644 --- a/algoliasearch/src/main/java/com/algolia/model/insights/Value.java +++ b/algoliasearch/src/main/java/com/algolia/model/insights/Value.java @@ -14,17 +14,17 @@ /** Total monetary value of this event in units of `currency`. */ @JsonDeserialize(using = Value.Deserializer.class) public interface Value { - /** Value as Double wrapper. */ + // Value as Double wrapper. static Value of(Double value) { return new DoubleWrapper(value); } - /** Value as String wrapper. */ + // Value as String wrapper. static Value of(String value) { return new StringWrapper(value); } - /** Value as Double wrapper. */ + // Value as Double wrapper. @JsonSerialize(using = DoubleWrapper.Serializer.class) class DoubleWrapper implements Value { @@ -47,7 +47,7 @@ public void serialize(DoubleWrapper value, JsonGenerator gen, SerializerProvider } } - /** Value as String wrapper. */ + // Value as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements Value { diff --git a/algoliasearch/src/main/java/com/algolia/model/querysuggestions/Languages.java b/algoliasearch/src/main/java/com/algolia/model/querysuggestions/Languages.java index bd22edaf5..d95fba82f 100644 --- a/algoliasearch/src/main/java/com/algolia/model/querysuggestions/Languages.java +++ b/algoliasearch/src/main/java/com/algolia/model/querysuggestions/Languages.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = Languages.Deserializer.class) public interface Languages { - /** Languages as List wrapper. */ + // Languages as List wrapper. static Languages of(List value) { return new ListOfStringWrapper(value); } - /** Languages as Boolean wrapper. */ + // Languages as Boolean wrapper. static Languages of(Boolean value) { return new BooleanWrapper(value); } - /** Languages as List wrapper. */ + // Languages as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements Languages { @@ -52,7 +52,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** Languages as Boolean wrapper. */ + // Languages as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements Languages { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/AroundPrecision.java b/algoliasearch/src/main/java/com/algolia/model/recommend/AroundPrecision.java index ec798847f..c3e45e449 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/AroundPrecision.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/AroundPrecision.java @@ -20,17 +20,17 @@ */ @JsonDeserialize(using = AroundPrecision.Deserializer.class) public interface AroundPrecision { - /** AroundPrecision as Integer wrapper. */ + // AroundPrecision as Integer wrapper. static AroundPrecision of(Integer value) { return new IntegerWrapper(value); } - /** AroundPrecision as List wrapper. */ + // AroundPrecision as List wrapper. static AroundPrecision of(List value) { return new ListOfAroundPrecisionFromValueInnerWrapper(value); } - /** AroundPrecision as Integer wrapper. */ + // AroundPrecision as Integer wrapper. @JsonSerialize(using = IntegerWrapper.Serializer.class) class IntegerWrapper implements AroundPrecision { @@ -53,7 +53,7 @@ public void serialize(IntegerWrapper value, JsonGenerator gen, SerializerProvide } } - /** AroundPrecision as List wrapper. */ + // AroundPrecision as List wrapper. @JsonSerialize(using = ListOfAroundPrecisionFromValueInnerWrapper.Serializer.class) class ListOfAroundPrecisionFromValueInnerWrapper implements AroundPrecision { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/AroundRadius.java b/algoliasearch/src/main/java/com/algolia/model/recommend/AroundRadius.java index 270b5de43..7ba809674 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/AroundRadius.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/AroundRadius.java @@ -18,12 +18,12 @@ */ @JsonDeserialize(using = AroundRadius.Deserializer.class) public interface AroundRadius { - /** AroundRadius as Integer wrapper. */ + // AroundRadius as Integer wrapper. static AroundRadius of(Integer value) { return new IntegerWrapper(value); } - /** AroundRadius as Integer wrapper. */ + // AroundRadius as Integer wrapper. @JsonSerialize(using = IntegerWrapper.Serializer.class) class IntegerWrapper implements AroundRadius { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/AutomaticFacetFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/AutomaticFacetFilters.java index d603abcc7..ec4c0bf95 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/AutomaticFacetFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/AutomaticFacetFilters.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = AutomaticFacetFilters.Deserializer.class) public interface AutomaticFacetFilters { - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. static AutomaticFacetFilters ofListOfAutomaticFacetFilter(List value) { return new ListOfAutomaticFacetFilterWrapper(value); } - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. static AutomaticFacetFilters ofListOfString(List value) { return new ListOfStringWrapper(value); } - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. @JsonSerialize(using = ListOfAutomaticFacetFilterWrapper.Serializer.class) class ListOfAutomaticFacetFilterWrapper implements AutomaticFacetFilters { @@ -52,7 +52,7 @@ public void serialize(ListOfAutomaticFacetFilterWrapper value, JsonGenerator gen } } - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements AutomaticFacetFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/ConsequenceQuery.java b/algoliasearch/src/main/java/com/algolia/model/recommend/ConsequenceQuery.java index 1c0e56001..506546945 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/ConsequenceQuery.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/ConsequenceQuery.java @@ -17,12 +17,12 @@ */ @JsonDeserialize(using = ConsequenceQuery.Deserializer.class) public interface ConsequenceQuery { - /** ConsequenceQuery as String wrapper. */ + // ConsequenceQuery as String wrapper. static ConsequenceQuery of(String value) { return new StringWrapper(value); } - /** ConsequenceQuery as String wrapper. */ + // ConsequenceQuery as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements ConsequenceQuery { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/Distinct.java b/algoliasearch/src/main/java/com/algolia/model/recommend/Distinct.java index fb1834f22..636f50cf3 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/Distinct.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/Distinct.java @@ -17,17 +17,17 @@ */ @JsonDeserialize(using = Distinct.Deserializer.class) public interface Distinct { - /** Distinct as Boolean wrapper. */ + // Distinct as Boolean wrapper. static Distinct of(Boolean value) { return new BooleanWrapper(value); } - /** Distinct as Integer wrapper. */ + // Distinct as Integer wrapper. static Distinct of(Integer value) { return new IntegerWrapper(value); } - /** Distinct as Boolean wrapper. */ + // Distinct as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements Distinct { @@ -50,7 +50,7 @@ public void serialize(BooleanWrapper value, JsonGenerator gen, SerializerProvide } } - /** Distinct as Integer wrapper. */ + // Distinct as Integer wrapper. @JsonSerialize(using = IntegerWrapper.Serializer.class) class IntegerWrapper implements Distinct { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/FacetFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/FacetFilters.java index 9a8d59261..651c1949c 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/FacetFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/FacetFilters.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = FacetFilters.Deserializer.class) public interface FacetFilters { - /** FacetFilters as List wrapper. */ + // FacetFilters as List wrapper. static FacetFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** FacetFilters as String wrapper. */ + // FacetFilters as String wrapper. static FacetFilters of(String value) { return new StringWrapper(value); } - /** FacetFilters as List wrapper. */ + // FacetFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements FacetFilters { @@ -52,7 +52,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** FacetFilters as String wrapper. */ + // FacetFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements FacetFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/HighlightResult.java b/algoliasearch/src/main/java/com/algolia/model/recommend/HighlightResult.java index e8d6b38b9..d5a279203 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/HighlightResult.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/HighlightResult.java @@ -16,12 +16,12 @@ /** HighlightResult */ @JsonDeserialize(using = HighlightResult.Deserializer.class) public interface HighlightResult { - /** HighlightResult as Map wrapper. */ + // HighlightResult as Map wrapper. static HighlightResult of(Map value) { return new MapOfStringHighlightResultOptionWrapper(value); } - /** HighlightResult as Map wrapper. */ + // HighlightResult as Map wrapper. @JsonSerialize(using = MapOfStringHighlightResultOptionWrapper.Serializer.class) class MapOfStringHighlightResultOptionWrapper implements HighlightResult { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/IgnorePlurals.java b/algoliasearch/src/main/java/com/algolia/model/recommend/IgnorePlurals.java index 377b1e2a8..aa67feeae 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/IgnorePlurals.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/IgnorePlurals.java @@ -26,17 +26,17 @@ */ @JsonDeserialize(using = IgnorePlurals.Deserializer.class) public interface IgnorePlurals { - /** IgnorePlurals as List wrapper. */ + // IgnorePlurals as List wrapper. static IgnorePlurals of(List value) { return new ListOfStringWrapper(value); } - /** IgnorePlurals as Boolean wrapper. */ + // IgnorePlurals as Boolean wrapper. static IgnorePlurals of(Boolean value) { return new BooleanWrapper(value); } - /** IgnorePlurals as List wrapper. */ + // IgnorePlurals as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements IgnorePlurals { @@ -59,7 +59,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** IgnorePlurals as Boolean wrapper. */ + // IgnorePlurals as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements IgnorePlurals { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/MixedSearchFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/MixedSearchFilters.java index cffb43b01..25c5ad6f1 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/MixedSearchFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/MixedSearchFilters.java @@ -16,17 +16,17 @@ /** MixedSearchFilters */ @JsonDeserialize(using = MixedSearchFilters.Deserializer.class) public interface MixedSearchFilters { - /** MixedSearchFilters as List wrapper. */ + // MixedSearchFilters as List wrapper. static MixedSearchFilters of(List value) { return new ListOfStringWrapper(value); } - /** MixedSearchFilters as String wrapper. */ + // MixedSearchFilters as String wrapper. static MixedSearchFilters of(String value) { return new StringWrapper(value); } - /** MixedSearchFilters as List wrapper. */ + // MixedSearchFilters as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements MixedSearchFilters { @@ -49,7 +49,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** MixedSearchFilters as String wrapper. */ + // MixedSearchFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements MixedSearchFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java index c19fe2c60..a99b8c7bb 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/NumericFilters.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = NumericFilters.Deserializer.class) public interface NumericFilters { - /** NumericFilters as List wrapper. */ + // NumericFilters as List wrapper. static NumericFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** NumericFilters as String wrapper. */ + // NumericFilters as String wrapper. static NumericFilters of(String value) { return new StringWrapper(value); } - /** NumericFilters as List wrapper. */ + // NumericFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements NumericFilters { @@ -52,7 +52,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** NumericFilters as String wrapper. */ + // NumericFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements NumericFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/OptionalFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/OptionalFilters.java index cd85f4be8..c087dfa40 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/OptionalFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/OptionalFilters.java @@ -21,17 +21,17 @@ */ @JsonDeserialize(using = OptionalFilters.Deserializer.class) public interface OptionalFilters { - /** OptionalFilters as List wrapper. */ + // OptionalFilters as List wrapper. static OptionalFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** OptionalFilters as String wrapper. */ + // OptionalFilters as String wrapper. static OptionalFilters of(String value) { return new StringWrapper(value); } - /** OptionalFilters as List wrapper. */ + // OptionalFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements OptionalFilters { @@ -54,7 +54,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** OptionalFilters as String wrapper. */ + // OptionalFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements OptionalFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/ReRankingApplyFilter.java b/algoliasearch/src/main/java/com/algolia/model/recommend/ReRankingApplyFilter.java index e4c72343f..b341663db 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/ReRankingApplyFilter.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/ReRankingApplyFilter.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = ReRankingApplyFilter.Deserializer.class) public interface ReRankingApplyFilter { - /** ReRankingApplyFilter as List wrapper. */ + // ReRankingApplyFilter as List wrapper. static ReRankingApplyFilter of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** ReRankingApplyFilter as String wrapper. */ + // ReRankingApplyFilter as String wrapper. static ReRankingApplyFilter of(String value) { return new StringWrapper(value); } - /** ReRankingApplyFilter as List wrapper. */ + // ReRankingApplyFilter as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements ReRankingApplyFilter { @@ -52,7 +52,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** ReRankingApplyFilter as String wrapper. */ + // ReRankingApplyFilter as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements ReRankingApplyFilter { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendationsHit.java b/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendationsHit.java index 533d00801..bd94c4538 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendationsHit.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/RecommendationsHit.java @@ -14,12 +14,12 @@ /** RecommendationsHit */ @JsonDeserialize(using = RecommendationsHit.Deserializer.class) public interface RecommendationsHit { - /** RecommendationsHit as RecommendHit wrapper. */ + // RecommendationsHit as RecommendHit wrapper. static RecommendationsHit of(RecommendHit value) { return new RecommendHitWrapper(value); } - /** RecommendationsHit as RecommendHit wrapper. */ + // RecommendationsHit as RecommendHit wrapper. @JsonSerialize(using = RecommendHitWrapper.Serializer.class) class RecommendHitWrapper implements RecommendationsHit { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/RemoveStopWords.java b/algoliasearch/src/main/java/com/algolia/model/recommend/RemoveStopWords.java index 7404ddcef..84f7753a9 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/RemoveStopWords.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/RemoveStopWords.java @@ -25,17 +25,17 @@ */ @JsonDeserialize(using = RemoveStopWords.Deserializer.class) public interface RemoveStopWords { - /** RemoveStopWords as List wrapper. */ + // RemoveStopWords as List wrapper. static RemoveStopWords of(List value) { return new ListOfStringWrapper(value); } - /** RemoveStopWords as Boolean wrapper. */ + // RemoveStopWords as Boolean wrapper. static RemoveStopWords of(Boolean value) { return new BooleanWrapper(value); } - /** RemoveStopWords as List wrapper. */ + // RemoveStopWords as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements RemoveStopWords { @@ -58,7 +58,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** RemoveStopWords as Boolean wrapper. */ + // RemoveStopWords as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements RemoveStopWords { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/SnippetResult.java b/algoliasearch/src/main/java/com/algolia/model/recommend/SnippetResult.java index f4b6c99f5..63edc8731 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/SnippetResult.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/SnippetResult.java @@ -16,12 +16,12 @@ /** SnippetResult */ @JsonDeserialize(using = SnippetResult.Deserializer.class) public interface SnippetResult { - /** SnippetResult as Map wrapper. */ + // SnippetResult as Map wrapper. static SnippetResult of(Map value) { return new MapOfStringSnippetResultOptionWrapper(value); } - /** SnippetResult as Map wrapper. */ + // SnippetResult as Map wrapper. @JsonSerialize(using = MapOfStringSnippetResultOptionWrapper.Serializer.class) class MapOfStringSnippetResultOptionWrapper implements SnippetResult { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/TagFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/TagFilters.java index 9684c816a..3bef3457e 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/TagFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/TagFilters.java @@ -16,17 +16,17 @@ /** [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/). */ @JsonDeserialize(using = TagFilters.Deserializer.class) public interface TagFilters { - /** TagFilters as List wrapper. */ + // TagFilters as List wrapper. static TagFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** TagFilters as String wrapper. */ + // TagFilters as String wrapper. static TagFilters of(String value) { return new StringWrapper(value); } - /** TagFilters as List wrapper. */ + // TagFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements TagFilters { @@ -49,7 +49,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** TagFilters as String wrapper. */ + // TagFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements TagFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java b/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java index 1c65c6cd6..691ed8382 100644 --- a/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java +++ b/algoliasearch/src/main/java/com/algolia/model/recommend/TypoTolerance.java @@ -18,12 +18,12 @@ */ @JsonDeserialize(using = TypoTolerance.Deserializer.class) public interface TypoTolerance { - /** TypoTolerance as Boolean wrapper. */ + // TypoTolerance as Boolean wrapper. static TypoTolerance of(Boolean value) { return new BooleanWrapper(value); } - /** TypoTolerance as Boolean wrapper. */ + // TypoTolerance as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements TypoTolerance { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/AroundPrecision.java b/algoliasearch/src/main/java/com/algolia/model/search/AroundPrecision.java index cd181ed81..e998053c2 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/AroundPrecision.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/AroundPrecision.java @@ -20,17 +20,17 @@ */ @JsonDeserialize(using = AroundPrecision.Deserializer.class) public interface AroundPrecision { - /** AroundPrecision as Integer wrapper. */ + // AroundPrecision as Integer wrapper. static AroundPrecision of(Integer value) { return new IntegerWrapper(value); } - /** AroundPrecision as List wrapper. */ + // AroundPrecision as List wrapper. static AroundPrecision of(List value) { return new ListOfAroundPrecisionFromValueInnerWrapper(value); } - /** AroundPrecision as Integer wrapper. */ + // AroundPrecision as Integer wrapper. @JsonSerialize(using = IntegerWrapper.Serializer.class) class IntegerWrapper implements AroundPrecision { @@ -53,7 +53,7 @@ public void serialize(IntegerWrapper value, JsonGenerator gen, SerializerProvide } } - /** AroundPrecision as List wrapper. */ + // AroundPrecision as List wrapper. @JsonSerialize(using = ListOfAroundPrecisionFromValueInnerWrapper.Serializer.class) class ListOfAroundPrecisionFromValueInnerWrapper implements AroundPrecision { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/AroundRadius.java b/algoliasearch/src/main/java/com/algolia/model/search/AroundRadius.java index 6ef807aee..1bc8acb3e 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/AroundRadius.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/AroundRadius.java @@ -18,12 +18,12 @@ */ @JsonDeserialize(using = AroundRadius.Deserializer.class) public interface AroundRadius { - /** AroundRadius as Integer wrapper. */ + // AroundRadius as Integer wrapper. static AroundRadius of(Integer value) { return new IntegerWrapper(value); } - /** AroundRadius as Integer wrapper. */ + // AroundRadius as Integer wrapper. @JsonSerialize(using = IntegerWrapper.Serializer.class) class IntegerWrapper implements AroundRadius { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/AttributeToUpdate.java b/algoliasearch/src/main/java/com/algolia/model/search/AttributeToUpdate.java index 0437d7d53..d6797dbfc 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/AttributeToUpdate.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/AttributeToUpdate.java @@ -14,12 +14,12 @@ /** AttributeToUpdate */ @JsonDeserialize(using = AttributeToUpdate.Deserializer.class) public interface AttributeToUpdate { - /** AttributeToUpdate as String wrapper. */ + // AttributeToUpdate as String wrapper. static AttributeToUpdate of(String value) { return new StringWrapper(value); } - /** AttributeToUpdate as String wrapper. */ + // AttributeToUpdate as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements AttributeToUpdate { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/AutomaticFacetFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/AutomaticFacetFilters.java index 86826706d..4295ebdfa 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/AutomaticFacetFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/AutomaticFacetFilters.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = AutomaticFacetFilters.Deserializer.class) public interface AutomaticFacetFilters { - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. static AutomaticFacetFilters ofListOfAutomaticFacetFilter(List value) { return new ListOfAutomaticFacetFilterWrapper(value); } - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. static AutomaticFacetFilters ofListOfString(List value) { return new ListOfStringWrapper(value); } - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. @JsonSerialize(using = ListOfAutomaticFacetFilterWrapper.Serializer.class) class ListOfAutomaticFacetFilterWrapper implements AutomaticFacetFilters { @@ -52,7 +52,7 @@ public void serialize(ListOfAutomaticFacetFilterWrapper value, JsonGenerator gen } } - /** AutomaticFacetFilters as List wrapper. */ + // AutomaticFacetFilters as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements AutomaticFacetFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceQuery.java b/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceQuery.java index 550625396..c07ce4f46 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceQuery.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/ConsequenceQuery.java @@ -17,12 +17,12 @@ */ @JsonDeserialize(using = ConsequenceQuery.Deserializer.class) public interface ConsequenceQuery { - /** ConsequenceQuery as String wrapper. */ + // ConsequenceQuery as String wrapper. static ConsequenceQuery of(String value) { return new StringWrapper(value); } - /** ConsequenceQuery as String wrapper. */ + // ConsequenceQuery as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements ConsequenceQuery { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/Distinct.java b/algoliasearch/src/main/java/com/algolia/model/search/Distinct.java index 00acd027e..4b9a5c60a 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/Distinct.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/Distinct.java @@ -17,17 +17,17 @@ */ @JsonDeserialize(using = Distinct.Deserializer.class) public interface Distinct { - /** Distinct as Boolean wrapper. */ + // Distinct as Boolean wrapper. static Distinct of(Boolean value) { return new BooleanWrapper(value); } - /** Distinct as Integer wrapper. */ + // Distinct as Integer wrapper. static Distinct of(Integer value) { return new IntegerWrapper(value); } - /** Distinct as Boolean wrapper. */ + // Distinct as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements Distinct { @@ -50,7 +50,7 @@ public void serialize(BooleanWrapper value, JsonGenerator gen, SerializerProvide } } - /** Distinct as Integer wrapper. */ + // Distinct as Integer wrapper. @JsonSerialize(using = IntegerWrapper.Serializer.class) class IntegerWrapper implements Distinct { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/FacetFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/FacetFilters.java index eab82026a..4195b1e83 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/FacetFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/FacetFilters.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = FacetFilters.Deserializer.class) public interface FacetFilters { - /** FacetFilters as List wrapper. */ + // FacetFilters as List wrapper. static FacetFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** FacetFilters as String wrapper. */ + // FacetFilters as String wrapper. static FacetFilters of(String value) { return new StringWrapper(value); } - /** FacetFilters as List wrapper. */ + // FacetFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements FacetFilters { @@ -52,7 +52,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** FacetFilters as String wrapper. */ + // FacetFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements FacetFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/HighlightResult.java b/algoliasearch/src/main/java/com/algolia/model/search/HighlightResult.java index 18db6d179..6b185bb49 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/HighlightResult.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/HighlightResult.java @@ -16,12 +16,12 @@ /** HighlightResult */ @JsonDeserialize(using = HighlightResult.Deserializer.class) public interface HighlightResult { - /** HighlightResult as Map wrapper. */ + // HighlightResult as Map wrapper. static HighlightResult of(Map value) { return new MapOfStringHighlightResultOptionWrapper(value); } - /** HighlightResult as Map wrapper. */ + // HighlightResult as Map wrapper. @JsonSerialize(using = MapOfStringHighlightResultOptionWrapper.Serializer.class) class MapOfStringHighlightResultOptionWrapper implements HighlightResult { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/IgnorePlurals.java b/algoliasearch/src/main/java/com/algolia/model/search/IgnorePlurals.java index 2397c2c67..d691eb8e2 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/IgnorePlurals.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/IgnorePlurals.java @@ -26,17 +26,17 @@ */ @JsonDeserialize(using = IgnorePlurals.Deserializer.class) public interface IgnorePlurals { - /** IgnorePlurals as List wrapper. */ + // IgnorePlurals as List wrapper. static IgnorePlurals of(List value) { return new ListOfStringWrapper(value); } - /** IgnorePlurals as Boolean wrapper. */ + // IgnorePlurals as Boolean wrapper. static IgnorePlurals of(Boolean value) { return new BooleanWrapper(value); } - /** IgnorePlurals as List wrapper. */ + // IgnorePlurals as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements IgnorePlurals { @@ -59,7 +59,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** IgnorePlurals as Boolean wrapper. */ + // IgnorePlurals as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements IgnorePlurals { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/MixedSearchFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/MixedSearchFilters.java index 91b3644a3..d991e56df 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/MixedSearchFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/MixedSearchFilters.java @@ -16,17 +16,17 @@ /** MixedSearchFilters */ @JsonDeserialize(using = MixedSearchFilters.Deserializer.class) public interface MixedSearchFilters { - /** MixedSearchFilters as List wrapper. */ + // MixedSearchFilters as List wrapper. static MixedSearchFilters of(List value) { return new ListOfStringWrapper(value); } - /** MixedSearchFilters as String wrapper. */ + // MixedSearchFilters as String wrapper. static MixedSearchFilters of(String value) { return new StringWrapper(value); } - /** MixedSearchFilters as List wrapper. */ + // MixedSearchFilters as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements MixedSearchFilters { @@ -49,7 +49,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** MixedSearchFilters as String wrapper. */ + // MixedSearchFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements MixedSearchFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java index ceb2668f8..c44f97876 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/NumericFilters.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = NumericFilters.Deserializer.class) public interface NumericFilters { - /** NumericFilters as List wrapper. */ + // NumericFilters as List wrapper. static NumericFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** NumericFilters as String wrapper. */ + // NumericFilters as String wrapper. static NumericFilters of(String value) { return new StringWrapper(value); } - /** NumericFilters as List wrapper. */ + // NumericFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements NumericFilters { @@ -52,7 +52,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** NumericFilters as String wrapper. */ + // NumericFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements NumericFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/OptionalFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/OptionalFilters.java index a60ad24b3..aca731f5c 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/OptionalFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/OptionalFilters.java @@ -21,17 +21,17 @@ */ @JsonDeserialize(using = OptionalFilters.Deserializer.class) public interface OptionalFilters { - /** OptionalFilters as List wrapper. */ + // OptionalFilters as List wrapper. static OptionalFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** OptionalFilters as String wrapper. */ + // OptionalFilters as String wrapper. static OptionalFilters of(String value) { return new StringWrapper(value); } - /** OptionalFilters as List wrapper. */ + // OptionalFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements OptionalFilters { @@ -54,7 +54,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** OptionalFilters as String wrapper. */ + // OptionalFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements OptionalFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/ReRankingApplyFilter.java b/algoliasearch/src/main/java/com/algolia/model/search/ReRankingApplyFilter.java index 50f182a8d..7908f7096 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/ReRankingApplyFilter.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/ReRankingApplyFilter.java @@ -19,17 +19,17 @@ */ @JsonDeserialize(using = ReRankingApplyFilter.Deserializer.class) public interface ReRankingApplyFilter { - /** ReRankingApplyFilter as List wrapper. */ + // ReRankingApplyFilter as List wrapper. static ReRankingApplyFilter of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** ReRankingApplyFilter as String wrapper. */ + // ReRankingApplyFilter as String wrapper. static ReRankingApplyFilter of(String value) { return new StringWrapper(value); } - /** ReRankingApplyFilter as List wrapper. */ + // ReRankingApplyFilter as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements ReRankingApplyFilter { @@ -52,7 +52,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** ReRankingApplyFilter as String wrapper. */ + // ReRankingApplyFilter as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements ReRankingApplyFilter { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/RemoveStopWords.java b/algoliasearch/src/main/java/com/algolia/model/search/RemoveStopWords.java index 10ca418a3..27c911013 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/RemoveStopWords.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/RemoveStopWords.java @@ -25,17 +25,17 @@ */ @JsonDeserialize(using = RemoveStopWords.Deserializer.class) public interface RemoveStopWords { - /** RemoveStopWords as List wrapper. */ + // RemoveStopWords as List wrapper. static RemoveStopWords of(List value) { return new ListOfStringWrapper(value); } - /** RemoveStopWords as Boolean wrapper. */ + // RemoveStopWords as Boolean wrapper. static RemoveStopWords of(Boolean value) { return new BooleanWrapper(value); } - /** RemoveStopWords as List wrapper. */ + // RemoveStopWords as List wrapper. @JsonSerialize(using = ListOfStringWrapper.Serializer.class) class ListOfStringWrapper implements RemoveStopWords { @@ -58,7 +58,7 @@ public void serialize(ListOfStringWrapper value, JsonGenerator gen, SerializerPr } } - /** RemoveStopWords as Boolean wrapper. */ + // RemoveStopWords as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements RemoveStopWords { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/SnippetResult.java b/algoliasearch/src/main/java/com/algolia/model/search/SnippetResult.java index 087ec85f5..3569e2d53 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/SnippetResult.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/SnippetResult.java @@ -16,12 +16,12 @@ /** SnippetResult */ @JsonDeserialize(using = SnippetResult.Deserializer.class) public interface SnippetResult { - /** SnippetResult as Map wrapper. */ + // SnippetResult as Map wrapper. static SnippetResult of(Map value) { return new MapOfStringSnippetResultOptionWrapper(value); } - /** SnippetResult as Map wrapper. */ + // SnippetResult as Map wrapper. @JsonSerialize(using = MapOfStringSnippetResultOptionWrapper.Serializer.class) class MapOfStringSnippetResultOptionWrapper implements SnippetResult { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/TagFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/TagFilters.java index b3bea2e2f..a8c571123 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/TagFilters.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/TagFilters.java @@ -16,17 +16,17 @@ /** [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/). */ @JsonDeserialize(using = TagFilters.Deserializer.class) public interface TagFilters { - /** TagFilters as List wrapper. */ + // TagFilters as List wrapper. static TagFilters of(List value) { return new ListOfMixedSearchFiltersWrapper(value); } - /** TagFilters as String wrapper. */ + // TagFilters as String wrapper. static TagFilters of(String value) { return new StringWrapper(value); } - /** TagFilters as List wrapper. */ + // TagFilters as List wrapper. @JsonSerialize(using = ListOfMixedSearchFiltersWrapper.Serializer.class) class ListOfMixedSearchFiltersWrapper implements TagFilters { @@ -49,7 +49,7 @@ public void serialize(ListOfMixedSearchFiltersWrapper value, JsonGenerator gen, } } - /** TagFilters as String wrapper. */ + // TagFilters as String wrapper. @JsonSerialize(using = StringWrapper.Serializer.class) class StringWrapper implements TagFilters { diff --git a/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java b/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java index c400a11ab..461219de4 100644 --- a/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java +++ b/algoliasearch/src/main/java/com/algolia/model/search/TypoTolerance.java @@ -18,12 +18,12 @@ */ @JsonDeserialize(using = TypoTolerance.Deserializer.class) public interface TypoTolerance { - /** TypoTolerance as Boolean wrapper. */ + // TypoTolerance as Boolean wrapper. static TypoTolerance of(Boolean value) { return new BooleanWrapper(value); } - /** TypoTolerance as Boolean wrapper. */ + // TypoTolerance as Boolean wrapper. @JsonSerialize(using = BooleanWrapper.Serializer.class) class BooleanWrapper implements TypoTolerance {