com.algolia.search.saas

Enum MirroredIndex.Strategy

Object

Enum<MirroredIndex.Strategy>

com.algolia.search.saas.MirroredIndex.Strategy

All Implemented Interfaces:

Serializable, Comparable<MirroredIndex.Strategy>

Enclosing class:

MirroredIndex

public static enum MirroredIndex.Strategy
extends Enum<MirroredIndex.Strategy>

Strategy to choose between online and offline search.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALLBACK_ON_FAILURE Search online, then fallback to offline on failure.
FALLBACK_ON_TIMEOUT Fallback after a certain timeout.
OFFLINE_ONLY Search offline only.
ONLINE_ONLY Search online only.

Method Summary

Modifier and Type	Method and Description
static MirroredIndex.Strategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static MirroredIndex.Strategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONLINE_ONLY

public static final MirroredIndex.Strategy ONLINE_ONLY

Search online only. The search will fail when the API can't be reached. NOTE: You might consider that this defeats the purpose of having a mirror in the first place... But this is intended for applications wanting to manually manage their policy.

OFFLINE_ONLY

public static final MirroredIndex.Strategy OFFLINE_ONLY

Search offline only. The search will fail when the offline mirror has not yet been synced.

FALLBACK_ON_FAILURE

public static final MirroredIndex.Strategy FALLBACK_ON_FAILURE

Search online, then fallback to offline on failure. Please note that when online, this is likely to hit the request timeout on every host before failing.

FALLBACK_ON_TIMEOUT

public static final MirroredIndex.Strategy FALLBACK_ON_TIMEOUT

Fallback after a certain timeout. Will first try an online request, but fallback to offline in case of failure or when a timeout has been reached, whichever comes first. The timeout can be set through MirroredIndex.setOfflineFallbackTimeout(long).

Method Detail

values

public static MirroredIndex.Strategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MirroredIndex.Strategy c : MirroredIndex.Strategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MirroredIndex.Strategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null