Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ List<SearchForFacetValuesResponse> SearchForFacets(
/// Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
/// Replace all objects in an index without any downtime. Internally, this method copies the existing index settings, synonyms and query rules and indexes all passed objects.
/// Finally, the temporary one replaces the existing index.
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
/// See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
/// </summary>
/// <param name="indexName">The index in which to perform the request.</param>
/// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ public suspend fun SearchClient.partialUpdateObjects(
* Internally, this method copies the existing index settings, synonyms and query rules and indexes all
* passed objects. Finally, the temporary one replaces the existing index.
*
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
*
* @param indexName The index in which to perform the request.
* @param objects The list of objects to replace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ package object extension {
* settings, synonyms and query rules and indexes all passed objects. Finally, the temporary one replaces the
* existing index.
*
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
*
* @param indexName
* The index in which to perform the request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ public extension SearchClient {

/// Replace all objects in an index
///
/// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
/// See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
/// details.
/// - parameter indexName: The name of the index where to replace the objects
/// - parameter objects: The new objects
Expand Down
4 changes: 2 additions & 2 deletions templates/go/search_helpers.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ func (c *APIClient) ChunkedBatch(indexName string, objects []map[string]any, act

/*
ReplaceAllObjectsWithTransformation is similar to the `replaceAllObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.

@param indexName string - the index name to replace objects into.
@param objects []map[string]any - List of objects to replace.
Expand Down Expand Up @@ -695,7 +695,7 @@ func (c *APIClient) ReplaceAllObjectsWithTransformation(indexName string, object

/*
ReplaceAllObjects replaces all objects (records) in the given `indexName` with the given `objects`. A temporary index is created during this process in order to backup your data.
See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.

@param indexName string - the index name to replace objects into.
@param objects []map[string]any - List of objects to replace.
Expand Down
8 changes: 4 additions & 4 deletions templates/java/api_helpers.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -1191,7 +1191,7 @@ public <T> List<BatchResponse> partialUpdateObjects(
/**
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
* untouched. Replace all records in an index without any downtime. See
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
* details.
*
* @param indexName The `indexName` to replace `objects` in.
Expand All @@ -1207,7 +1207,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
/**
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
* untouched. Replace all records in an index without any downtime. See
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
* details.
*
* @param indexName The `indexName` to replace `objects` in.
Expand All @@ -1225,7 +1225,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
/**
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
* untouched. Replace all records in an index without any downtime. See
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
* details.
*
* @param indexName The `indexName` to replace `objects` in.
Expand All @@ -1244,7 +1244,7 @@ public <T> ReplaceAllObjectsResponse replaceAllObjects(String indexName, Iterabl
/**
* Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
* untouched. Replace all records in an index without any downtime. See
* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
* https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation
* details.
*
* @param indexName The `indexName` to replace `objects` in.
Expand Down
2 changes: 1 addition & 1 deletion templates/javascript/clients/client/api/helpers.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ async partialUpdateObjects(

/**
* Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
*
* @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
* @param replaceAllObjects - The `replaceAllObjects` object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ generateSecuredApiKey: ({

/**
* Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
*
* @summary Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`.
* @param accountCopyIndex - The `accountCopyIndex` object.
Expand Down
2 changes: 1 addition & 1 deletion templates/php/api.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;

/**
* Helper: Replace all objects in an index using a temporary one.
* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
* See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
*
* @param string $indexName The `indexName` to replace `objects` in.
* @param array $objects The array of `objects` to store in the given Algolia `indexName`.
Expand Down
4 changes: 2 additions & 2 deletions templates/python/search_helpers.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@
"""
Helper: Similar to the `replaceAllObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.

See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
"""
if self._ingestion_transporter is None:
raise ValueError("`region` must be provided at client instantiation before calling this method.")
Expand Down Expand Up @@ -466,7 +466,7 @@
"""
Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.

See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
See https://api-clients-automation.netlify.app/docs/custom-helpers/#replaceallobjects for implementation details.
"""
tmp_index_name = self.create_temporary_name(index_name)

Expand Down
Loading