Package com.algolia.search

Interface SearchClientDictionary

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientDictionary
extends SearchClientBase

Method Summary

Modifier and Type	Method	Description
default DictionaryResponse	clearDictionaryEntries(Dictionary dictionary)	Clear all dictionary entries.
default DictionaryResponse	clearDictionaryEntries(Dictionary dictionary, RequestOptions requestOptions)	Clear all dictionary entries.
default CompletableFuture<DictionaryResponse>	clearDictionaryEntriesAsync(Dictionary dictionary)	Clear all dictionary entries.
default CompletableFuture<DictionaryResponse>	clearDictionaryEntriesAsync(Dictionary dictionary, RequestOptions requestOptions)	Clear all dictionary entries.
default DictionaryResponse	deleteDictionaryEntries(Dictionary dictionary, List<String> objectIDs)	Delete dictionary entries.
default DictionaryResponse	deleteDictionaryEntries(Dictionary dictionary, List<String> objectIDs, RequestOptions requestOptions)	Delete dictionary entries.
default CompletableFuture<DictionaryResponse>	deleteDictionaryEntriesAsync(Dictionary dictionary, List<String> objectIDs)	Delete dictionary entries.
default CompletableFuture<DictionaryResponse>	deleteDictionaryEntriesAsync(Dictionary dictionary, List<String> objectIDs, RequestOptions requestOptions)	Delete dictionary entries.
default DictionarySettings	getDictionarySettings()	Retrieve dictionaries settings.
default DictionarySettings	getDictionarySettings(RequestOptions requestOptions)	Retrieve dictionaries settings.
default CompletableFuture<DictionarySettings>	getDictionarySettingsAsync()	Retrieve dictionaries settings.
default CompletableFuture<DictionarySettings>	getDictionarySettingsAsync(RequestOptions requestOptions)	Retrieve dictionaries settings.
default DictionaryResponse	replaceDictionaryEntries(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries)	Replace dictionary entries.
default DictionaryResponse	replaceDictionaryEntries(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries, RequestOptions requestOptions)	Replace dictionary entries.
default CompletableFuture<DictionaryResponse>	replaceDictionaryEntriesAsync(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries)	Replace dictionary entries.
default CompletableFuture<DictionaryResponse>	replaceDictionaryEntriesAsync(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries, RequestOptions requestOptions)	Replace dictionary entries.
default DictionaryResponse	saveDictionaryEntries(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries)	Save dictionary entries.
default DictionaryResponse	saveDictionaryEntries(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries, RequestOptions requestOptions)	Save dictionary entries.
default CompletableFuture<DictionaryResponse>	saveDictionaryEntriesAsync(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries)	Save dictionary entries.
default CompletableFuture<DictionaryResponse>	saveDictionaryEntriesAsync(Dictionary dictionary, List<DictionaryEntry> dictionaryEntries, RequestOptions requestOptions)	Save dictionary entries.
default <T> SearchResult<T>	searchDictionaryEntries(Dictionary dictionary, Query query)	Search the dictionary entries.
default <T> SearchResult<T>	searchDictionaryEntries(Dictionary dictionary, Query query, RequestOptions requestOptions)	Search the dictionary entries.
default <T> CompletableFuture<SearchResult<T>>	searchDictionaryEntriesAsync(Dictionary dictionary, Query query)	Search the dictionary entries.
default <T> CompletableFuture<SearchResult<T>>	searchDictionaryEntriesAsync(Dictionary dictionary, Query query, RequestOptions requestOptions)	Search the dictionary entries.
default DictionaryResponse	setDictionarySettings(DictionarySettings dictionarySettings)	Update dictionary settings.
default DictionaryResponse	setDictionarySettings(DictionarySettings dictionarySettings, RequestOptions requestOptions)	Update dictionary settings.
default CompletableFuture<DictionaryResponse>	setDictionarySettingsAsync(DictionarySettings dictionarySettings)	Update dictionary settings.
default CompletableFuture<DictionaryResponse>	setDictionarySettingsAsync(DictionarySettings dictionarySettings, RequestOptions requestOptions)	Update dictionary settings.

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitAppTask, waitAppTask, waitTask, waitTask

Method Detail

saveDictionaryEntries

default DictionaryResponse saveDictionaryEntries(@Nonnull
                                                 Dictionary dictionary,
                                                 @Nonnull
                                                 List<DictionaryEntry> dictionaryEntries)

Save dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be saved.

saveDictionaryEntries

default DictionaryResponse saveDictionaryEntries(@Nonnull
                                                 Dictionary dictionary,
                                                 @Nonnull
                                                 List<DictionaryEntry> dictionaryEntries,
                                                 RequestOptions requestOptions)

Save dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be saved. entries from the dictionary.

requestOptions - Configure request locally with RequestOptions.

saveDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> saveDictionaryEntriesAsync(@Nonnull
                                                                         Dictionary dictionary,
                                                                         @Nonnull
                                                                         List<DictionaryEntry> dictionaryEntries)

Save dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be saved.

saveDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> saveDictionaryEntriesAsync(@Nonnull
                                                                         Dictionary dictionary,
                                                                         @Nonnull
                                                                         List<DictionaryEntry> dictionaryEntries,
                                                                         RequestOptions requestOptions)

Save dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be saved.

requestOptions - Configure request locally with RequestOptions.

replaceDictionaryEntries

default DictionaryResponse replaceDictionaryEntries(@Nonnull
                                                    Dictionary dictionary,
                                                    @Nonnull
                                                    List<DictionaryEntry> dictionaryEntries)

Replace dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be replaced.

replaceDictionaryEntries

default DictionaryResponse replaceDictionaryEntries(@Nonnull
                                                    Dictionary dictionary,
                                                    @Nonnull
                                                    List<DictionaryEntry> dictionaryEntries,
                                                    RequestOptions requestOptions)

Replace dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be replaced.

requestOptions - Configure request locally with RequestOptions.

replaceDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> replaceDictionaryEntriesAsync(@Nonnull
                                                                            Dictionary dictionary,
                                                                            @Nonnull
                                                                            List<DictionaryEntry> dictionaryEntries)

Replace dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be replaced.

replaceDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> replaceDictionaryEntriesAsync(@Nonnull
                                                                            Dictionary dictionary,
                                                                            @Nonnull
                                                                            List<DictionaryEntry> dictionaryEntries,
                                                                            RequestOptions requestOptions)

Replace dictionary entries.

Parameters:

dictionary - Target dictionary.

dictionaryEntries - dictionary entries to be replaced.

requestOptions - Configure request locally with RequestOptions.

deleteDictionaryEntries

default DictionaryResponse deleteDictionaryEntries(@Nonnull
                                                   Dictionary dictionary,
                                                   @Nonnull
                                                   List<String> objectIDs)

Delete dictionary entries.

Parameters:

dictionary - Target dictionary.

objectIDs - list of entries' IDs to delete.

deleteDictionaryEntries

default DictionaryResponse deleteDictionaryEntries(@Nonnull
                                                   Dictionary dictionary,
                                                   @Nonnull
                                                   List<String> objectIDs,
                                                   RequestOptions requestOptions)

Delete dictionary entries.

Parameters:

dictionary - Target dictionary.

objectIDs - list of entries' IDs to delete.

requestOptions - Configure request locally with RequestOptions.

deleteDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> deleteDictionaryEntriesAsync(@Nonnull
                                                                           Dictionary dictionary,
                                                                           @Nonnull
                                                                           List<String> objectIDs)

Delete dictionary entries.

Parameters:

dictionary - Target dictionary.

objectIDs - list of entries' IDs to delete.

deleteDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> deleteDictionaryEntriesAsync(@Nonnull
                                                                           Dictionary dictionary,
                                                                           @Nonnull
                                                                           List<String> objectIDs,
                                                                           RequestOptions requestOptions)

Delete dictionary entries.

Parameters:

dictionary - Target dictionary.

objectIDs - list of entries' IDs to delete.

requestOptions - Configure request locally with RequestOptions.

clearDictionaryEntries

default DictionaryResponse clearDictionaryEntries(@Nonnull
                                                  Dictionary dictionary)

Clear all dictionary entries.

Parameters:

dictionary - Target dictionary.

clearDictionaryEntries

default DictionaryResponse clearDictionaryEntries(@Nonnull
                                                  Dictionary dictionary,
                                                  RequestOptions requestOptions)

Clear all dictionary entries.

Parameters:

dictionary - Target dictionary.

requestOptions - Configure request locally with RequestOptions.

clearDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> clearDictionaryEntriesAsync(@Nonnull
                                                                          Dictionary dictionary)

Clear all dictionary entries.

Parameters:

dictionary - Target dictionary.

clearDictionaryEntriesAsync

default CompletableFuture<DictionaryResponse> clearDictionaryEntriesAsync(@Nonnull
                                                                          Dictionary dictionary,
                                                                          RequestOptions requestOptions)

Clear all dictionary entries.

Parameters:

dictionary - Target dictionary.

requestOptions - Configure request locally with RequestOptions.

searchDictionaryEntries

default <T> SearchResult<T> searchDictionaryEntries(@Nonnull
                                                    Dictionary dictionary,
                                                    @Nonnull
                                                    Query query)

Search the dictionary entries.

Parameters:

dictionary - Target dictionary.

query - the Query used to search.

searchDictionaryEntries

default <T> SearchResult<T> searchDictionaryEntries(@Nonnull
                                                    Dictionary dictionary,
                                                    @Nonnull
                                                    Query query,
                                                    RequestOptions requestOptions)

Search the dictionary entries.

Parameters:

dictionary - Target dictionary.

query - the Query used to search.

requestOptions - Configure request locally with RequestOptions.

searchDictionaryEntriesAsync

default <T> CompletableFuture<SearchResult<T>> searchDictionaryEntriesAsync(@Nonnull
                                                                            Dictionary dictionary,
                                                                            @Nonnull
                                                                            Query query)

Search the dictionary entries.

Parameters:

dictionary - Target dictionary.

query - the Query used to search.

searchDictionaryEntriesAsync

default <T> CompletableFuture<SearchResult<T>> searchDictionaryEntriesAsync(@Nonnull
                                                                            Dictionary dictionary,
                                                                            @Nonnull
                                                                            Query query,
                                                                            RequestOptions requestOptions)

Search the dictionary entries.

Parameters:

dictionary - Target dictionary.

query - the Query used to search.

requestOptions - Configure request locally with RequestOptions.

setDictionarySettings

default DictionaryResponse setDictionarySettings(@Nonnull
                                                 DictionarySettings dictionarySettings)

Update dictionary settings. Only specified settings are overridden; unspecified settings are left unchanged. Specifying `null` for a setting resets it to its default value.

Parameters:

dictionarySettings - settings to be applied.

setDictionarySettings

default DictionaryResponse setDictionarySettings(@Nonnull
                                                 DictionarySettings dictionarySettings,
                                                 RequestOptions requestOptions)

Update dictionary settings. Only specified settings are overridden; unspecified settings are left unchanged. Specifying `null` for a setting resets it to its default value.

Parameters:

dictionarySettings - settings to be applied.

requestOptions - Configure request locally with RequestOptions.

setDictionarySettingsAsync

default CompletableFuture<DictionaryResponse> setDictionarySettingsAsync(@Nonnull
                                                                         DictionarySettings dictionarySettings)

Update dictionary settings. Only specified settings are overridden; unspecified settings are left unchanged. Specifying `null` for a setting resets it to its default value.

Parameters:

dictionarySettings - settings to be applied.

setDictionarySettingsAsync

default CompletableFuture<DictionaryResponse> setDictionarySettingsAsync(@Nonnull
                                                                         DictionarySettings dictionarySettings,
                                                                         RequestOptions requestOptions)

Update dictionary settings. Only specified settings are overridden; unspecified settings are left unchanged. Specifying `null` for a setting resets it to its default value.

Parameters:

dictionarySettings - settings to be applied.

requestOptions - Configure request locally with RequestOptions.

getDictionarySettings

default DictionarySettings getDictionarySettings()

Retrieve dictionaries settings.

getDictionarySettings

default DictionarySettings getDictionarySettings(RequestOptions requestOptions)

Retrieve dictionaries settings.

Parameters:

requestOptions - Configure request locally with RequestOptions.

getDictionarySettingsAsync

default CompletableFuture<DictionarySettings> getDictionarySettingsAsync()

Retrieve dictionaries settings.

getDictionarySettingsAsync

default CompletableFuture<DictionarySettings> getDictionarySettingsAsync(RequestOptions requestOptions)

Retrieve dictionaries settings.

Parameters:

requestOptions - Configure request locally with RequestOptions.