Skip to content

Commit 2eec2ac

Browse files
committed
chore: description
1 parent 916186a commit 2eec2ac

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

templates/java/api_helpers.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ private <T> List<PushTaskRecords> objectsToPushTaskRecords(Iterable<T> objects)
3131
* connector setup (e.g. a tmp index), but you wish to attach another index's transformation
3232
* to it (e.g. the source index name).
3333
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded
34-
* to the `getTask` method and merged with the transporter requestOptions.
34+
* to the `getEvent` method and merged with the transporter requestOptions.
3535
*/
3636
public <T> List<WatchResponse> chunkedPush(
3737
String indexName,

templates/javascript/clients/algoliasearch/builds/definition.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export type Algoliasearch = SearchClient & {
4242
* @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
4343
* @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
4444
* @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
45-
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
45+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
4646
*/
4747
saveObjectsWithTransformation: (options: SaveObjectsOptions, requestOptions?: RequestOptions | undefined) => Promise<Array<WatchResponse>>;
4848

@@ -56,7 +56,7 @@ export type Algoliasearch = SearchClient & {
5656
* @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
5757
* @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
5858
* @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
59-
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
59+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `push` method and merged with the transporter requestOptions.
6060
*/
6161
partialUpdateObjectsWithTransformation: (options: PartialUpdateObjectsOptions, requestOptions?: RequestOptions | undefined) => Promise<Array<WatchResponse>>;
6262

templates/php/api.mustache

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
321321
* @param array $objects the array of `objects` to store in the given Algolia `indexName`
322322
* @param array $action the `batch` `action` to perform on the given array of `objects`, defaults to `addObject`
323323
* @param bool $waitForTasks whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
324-
* @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
324+
* @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
325325
* @param array $referenceIndexName This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
326326
* @param array $requestOptions Request options
327327
*/
@@ -623,7 +623,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
623623
* @param string $indexName the `indexName` to replace `objects` in
624624
* @param array $objects the array of `objects` to store in the given Algolia `indexName`
625625
* @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
626-
* @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
626+
* @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
627627
* @param array $requestOptions Request options
628628
*/
629629
public function saveObjectsWithTransformation($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
@@ -679,7 +679,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
679679
* @param array $objects the array of `objects` to store in the given Algolia `indexName`
680680
* @param bool $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail..
681681
* @param bool $waitForTasks Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
682-
* @param array $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
682+
* @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
683683
* @param array $requestOptions Request options
684684
*/
685685
public function partialUpdateObjectsWithTransformation($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])

0 commit comments

Comments
 (0)