Package com.algolia.search

Interface SyncBrowse<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncBrowse<T>
extends SyncBaseIndex<T>

Method Summary

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

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Method Detail

browse

default IndexIterable<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 IndexIterable<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 BrowseResult<T> browseFrom(@Nonnull
                                   Query query,
                                   @Nullable
                                   String cursor)
                            throws AlgoliaException

Browse all the content of this index

Parameters:

query - The query to use to browse

cursor - the cursor to start from

Returns:

browse result

Throws:

AlgoliaException

browseFrom

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

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

Throws:

AlgoliaException