org.elasticsearch.cluster.block
Class ClusterBlock

java.lang.Object
  org.elasticsearch.cluster.block.ClusterBlock

All Implemented Interfaces:

java.io.Serializable, Streamable, ToXContent

public class ClusterBlock
extends java.lang.Object
implements java.io.Serializable, Streamable, ToXContent

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

ClusterBlock(int id, java.lang.String description, boolean retryable, boolean disableStatePersistence, ClusterBlockLevel... levels)

Method Summary

boolean	contains(ClusterBlockLevel level)
java.lang.String	description()
boolean	disableStatePersistence() Should global state persistence be disabled when this block is present.
boolean	equals(java.lang.Object o)
int	hashCode()
int	id()
ClusterBlockLevel[]	levels()
static ClusterBlock	readClusterBlock(StreamInput in)
void	readFrom(StreamInput in)
boolean	retryable() Should operations get into retry state if this block is present.
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterBlock

public ClusterBlock(int id,
                    java.lang.String description,
                    boolean retryable,
                    boolean disableStatePersistence,
                    ClusterBlockLevel... levels)

Method Detail

id

public int id()

description

public java.lang.String description()

levels

public ClusterBlockLevel[] levels()

contains

public boolean contains(ClusterBlockLevel level)

retryable

public boolean retryable()

Should operations get into retry state if this block is present.

disableStatePersistence

public boolean disableStatePersistence()

Should global state persistence be disabled when this block is present. Note, only relevant for global blocks.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readClusterBlock

public static ClusterBlock readClusterBlock(StreamInput in)
                                     throws java.io.IOException

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object