Module org.elasticsearch.server

Package org.elasticsearch.transport

Enum Class RemoteClusterService.DisconnectedStrategy

java.lang.Object

java.lang.Enum<RemoteClusterService.DisconnectedStrategy>

org.elasticsearch.transport.RemoteClusterService.DisconnectedStrategy

All Implemented Interfaces:

Serializable, Comparable<RemoteClusterService.DisconnectedStrategy>, Constable

Enclosing class:

RemoteClusterService

public static enum RemoteClusterService.DisconnectedStrategy
extends Enum<RemoteClusterService.DisconnectedStrategy>

Specifies how to behave when executing a request against a disconnected remote cluster.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL_IF_DISCONNECTED	Fail the request immediately if the remote cluster is disconnected (but also trigger another attempt to reconnect to the remote cluster in the background so that the next request might succeed).
RECONNECT_IF_DISCONNECTED	Always try and reconnect before executing a request, waiting for TransportSettings.CONNECT_TIMEOUT before failing if the remote cluster is totally unresponsive.
RECONNECT_UNLESS_SKIP_UNAVAILABLE	Behave according to the RemoteClusterService.REMOTE_CLUSTER_SKIP_UNAVAILABLE setting for this remote cluster: if this setting is false (the default) then behave like RECONNECT_IF_DISCONNECTED, but if it is true then behave like FAIL_IF_DISCONNECTED.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RECONNECT_IF_DISCONNECTED

public static final RemoteClusterService.DisconnectedStrategy RECONNECT_IF_DISCONNECTED

Always try and reconnect before executing a request, waiting for TransportSettings.CONNECT_TIMEOUT before failing if the remote cluster is totally unresponsive.

FAIL_IF_DISCONNECTED

public static final RemoteClusterService.DisconnectedStrategy FAIL_IF_DISCONNECTED

Fail the request immediately if the remote cluster is disconnected (but also trigger another attempt to reconnect to the remote cluster in the background so that the next request might succeed).

RECONNECT_UNLESS_SKIP_UNAVAILABLE

public static final RemoteClusterService.DisconnectedStrategy RECONNECT_UNLESS_SKIP_UNAVAILABLE

Behave according to the RemoteClusterService.REMOTE_CLUSTER_SKIP_UNAVAILABLE setting for this remote cluster: if this setting is false (the default) then behave like RECONNECT_IF_DISCONNECTED, but if it is true then behave like FAIL_IF_DISCONNECTED.

Method Details

values

public static RemoteClusterService.DisconnectedStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RemoteClusterService.DisconnectedStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null