Package org.elasticsearch.cluster

Interface ClusterStateTaskConfig

All Known Implementing Classes:

AckedClusterStateUpdateTask, ClusterStateTaskConfig.Basic, ClusterStateUpdateTask, LocalClusterUpdateTask, MigrationResultsUpdateTask, SystemIndexMetadataUpgradeService.SystemIndexMetadataUpdateTask

public interface ClusterStateTaskConfig

Cluster state update task configuration for timeout and priority

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ClusterStateTaskConfig.Basic

Method Summary

Modifier and Type	Method	Description
static ClusterStateTaskConfig	build(Priority priority)	Build a cluster state update task configuration with the specified Priority and no timeout.
static ClusterStateTaskConfig	build(Priority priority, TimeValue timeout)	Build a cluster state update task configuration with the specified Priority and timeout.
Priority	priority()	The Priority for this cluster state update task configuration.
TimeValue	timeout()	The timeout for this cluster state update task configuration.

Method Details

timeout

@Nullable
TimeValue timeout()

The timeout for this cluster state update task configuration. If the cluster state update task isn't processed within this timeout, the associated ClusterStateTaskListener.onFailure(String, Exception) is invoked.

Returns:

the timeout, or null if one is not set

priority

Priority priority()

The Priority for this cluster state update task configuration.

Returns:

the priority

build

static ClusterStateTaskConfig build(Priority priority)

Build a cluster state update task configuration with the specified Priority and no timeout.

Parameters:

priority - the priority for the associated cluster state update task

Returns:

the resulting cluster state update task configuration

build

static ClusterStateTaskConfig build(Priority priority,
 TimeValue timeout)

Build a cluster state update task configuration with the specified Priority and timeout.

Parameters:

priority - the priority for the associated cluster state update task

timeout - the timeout for the associated cluster state update task

Returns:

the result cluster state update task configuration