Package org.elasticsearch.test

Annotation Type ESIntegTestCase.ClusterScope

@Retention(RUNTIME)
@Target(TYPE)
public static @interface ESIntegTestCase.ClusterScope

Defines a cluster scope for a ESIntegTestCase subclass. By default if no ESIntegTestCase.ClusterScope annotation is present ESIntegTestCase.Scope.SUITE is used together with randomly chosen settings like number of nodes etc.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	autoMinMasterNodes	The cluster automatically manages the ElectMasterService.DISCOVERY_ZEN_MINIMUM_MASTER_NODES_SETTING by default as nodes are started and stopped.
int	maxNumDataNodes	Returns the maximum number of data nodes in the cluster.
int	minNumDataNodes	Returns the minimum number of data nodes in the cluster.
int	numClientNodes	Returns the number of client nodes in the cluster.
int	numDataNodes	Returns the number of nodes in the cluster.
ESIntegTestCase.Scope	scope	Returns the scope.
boolean	supportsDedicatedMasters	Indicates whether the cluster can have dedicated master nodes.
double	transportClientRatio	Returns the transport client ratio.

Element Detail

scope

ESIntegTestCase.Scope scope

Returns the scope. ESIntegTestCase.Scope.SUITE is default.

Default:

org.elasticsearch.test.ESIntegTestCase.Scope.SUITE

numDataNodes

int numDataNodes

Returns the number of nodes in the cluster. Default is -1 which means a random number of nodes is used, where the minimum and maximum number of nodes are either the specified ones or the default ones if not specified.

Default:

-1

minNumDataNodes

int minNumDataNodes

Returns the minimum number of data nodes in the cluster. Default is -1. Ignored when numDataNodes() is set.

Default:

-1

maxNumDataNodes

int maxNumDataNodes

Returns the maximum number of data nodes in the cluster. Default is -1. Ignored when numDataNodes() is set.

Default:

-1

supportsDedicatedMasters

boolean supportsDedicatedMasters

Indicates whether the cluster can have dedicated master nodes. If false means data nodes will serve as master nodes and there will be no dedicated master (and data) nodes. Default is false which means dedicated master nodes will be randomly used.

Default:

true

autoMinMasterNodes

boolean autoMinMasterNodes

The cluster automatically manages the ElectMasterService.DISCOVERY_ZEN_MINIMUM_MASTER_NODES_SETTING by default as nodes are started and stopped. Set this to false to manage the setting manually.

Default:

true

numClientNodes

int numClientNodes

Returns the number of client nodes in the cluster. Default is InternalTestCluster.DEFAULT_NUM_CLIENT_NODES, a negative value means that the number of client nodes will be randomized.

Default:

-1

transportClientRatio

double transportClientRatio

Returns the transport client ratio. By default this returns -1 which means a random ratio in the interval [0..1] is used.

Default:

-1.0