org.elasticsearch.cluster.block

Class ClusterBlocks

java.lang.Object

org.elasticsearch.cluster.AbstractDiffable<ClusterBlocks>

org.elasticsearch.cluster.block.ClusterBlocks

All Implemented Interfaces:

Diffable<ClusterBlocks>, StreamableReader<ClusterBlocks>, Writeable<ClusterBlocks>

public class ClusterBlocks
extends AbstractDiffable<ClusterBlocks>

Represents current cluster level blocks to block dirty operations done against the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterBlocks.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ClusterBlocks	EMPTY_CLUSTER_BLOCK
static ClusterBlocks	PROTO

Method Summary

Methods

Modifier and Type	Method and Description
static ClusterBlocks.Builder	builder()
boolean	disableStatePersistence() Returns true if one of the global blocks as its disable state persistence flag set.
com.google.common.collect.ImmutableSet<ClusterBlock>	global()
com.google.common.collect.ImmutableSet<ClusterBlock>	global(ClusterBlockLevel level)
ClusterBlockException	globalBlockedException(ClusterBlockLevel level)
void	globalBlockedRaiseException(ClusterBlockLevel level)
boolean	hasGlobalBlock(ClusterBlock block)
boolean	hasGlobalBlock(ClusterBlockLevel level)
boolean	hasGlobalBlock(int blockId)
boolean	hasGlobalBlock(RestStatus status) Is there a global block with the provided status?
boolean	hasIndexBlock(String index, ClusterBlock block)
boolean	indexBlocked(ClusterBlockLevel level, String index)
ClusterBlockException	indexBlockedException(ClusterBlockLevel level, String index)
void	indexBlockedRaiseException(ClusterBlockLevel level, String index)
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<ClusterBlock>>	indices()
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<ClusterBlock>>	indices(ClusterBlockLevel level)
ClusterBlockException	indicesBlockedException(ClusterBlockLevel level, String[] indices)
String	prettyPrint()
ClusterBlocks	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, get, readDiffFrom, readDiffFrom

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_CLUSTER_BLOCK

public static final ClusterBlocks EMPTY_CLUSTER_BLOCK

PROTO

public static final ClusterBlocks PROTO

Method Detail

global

public com.google.common.collect.ImmutableSet<ClusterBlock> global()

indices

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<ClusterBlock>> indices()

global

public com.google.common.collect.ImmutableSet<ClusterBlock> global(ClusterBlockLevel level)

indices

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableSet<ClusterBlock>> indices(ClusterBlockLevel level)

disableStatePersistence

public boolean disableStatePersistence()

Returns true if one of the global blocks as its disable state persistence flag set.

hasGlobalBlock

public boolean hasGlobalBlock(ClusterBlock block)

hasGlobalBlock

public boolean hasGlobalBlock(int blockId)

hasGlobalBlock

public boolean hasGlobalBlock(ClusterBlockLevel level)

hasGlobalBlock

public boolean hasGlobalBlock(RestStatus status)

Is there a global block with the provided status?

hasIndexBlock

public boolean hasIndexBlock(String index,
                    ClusterBlock block)

globalBlockedRaiseException

public void globalBlockedRaiseException(ClusterBlockLevel level)
                                 throws ClusterBlockException

Throws:

ClusterBlockException

globalBlockedException

public ClusterBlockException globalBlockedException(ClusterBlockLevel level)

indexBlockedRaiseException

public void indexBlockedRaiseException(ClusterBlockLevel level,
                              String index)
                                throws ClusterBlockException

Throws:

ClusterBlockException

indexBlockedException

public ClusterBlockException indexBlockedException(ClusterBlockLevel level,
                                          String index)

indexBlocked

public boolean indexBlocked(ClusterBlockLevel level,
                   String index)

indicesBlockedException

public ClusterBlockException indicesBlockedException(ClusterBlockLevel level,
                                            String[] indices)

prettyPrint

public String prettyPrint()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Throws:

IOException

readFrom

public ClusterBlocks readFrom(StreamInput in)
                       throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Throws:

IOException

builder

public static ClusterBlocks.Builder builder()