com.algolia.search

Interface AsyncBrowse<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncBrowse<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default AsyncIndexIterable<T>	browse(Query query) Browse all the content of this index
default AsyncIndexIterable<T>	browse(Query query, RequestOptions requestOptions) Browse all the content of this index
default CompletableFuture<BrowseResult<T>>	browseFrom(Query query, String cursor) Browse all the content of this index
default CompletableFuture<BrowseResult<T>>	browseFrom(Query query, String cursor, RequestOptions requestOptions) Browse all the content of this index

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

browse

default AsyncIndexIterable<T> browse(@Nonnull
                                     Query query)

Browse all the content of this index

Parameters:

query - The query to use to browse

Returns:

the iterator on top of this index

browse

default AsyncIndexIterable<T> browse(@Nonnull
                                     Query query,
                                     @Nonnull
                                     RequestOptions requestOptions)

Browse all the content of this index

Parameters:

query - The query to use to browse

requestOptions - Options to pass to this request

Returns:

the iterator on top of this index

browseFrom

default CompletableFuture<BrowseResult<T>> browseFrom(@Nonnull
                                                      Query query,
                                                      @Nullable
                                                      String cursor)

Browse all the content of this index

Parameters:

query - The query to use to browse

cursor - the cursor to start from

Returns:

browse result

browseFrom

default CompletableFuture<BrowseResult<T>> browseFrom(@Nonnull
                                                      Query query,
                                                      @Nullable
                                                      String cursor,
                                                      @Nonnull
                                                      RequestOptions requestOptions)

Browse all the content of this index

Parameters:

query - The query to use to browse

cursor - the cursor to start from

requestOptions - Options to pass to this request

Returns:

the iterator on top of this index