Package org.elasticsearch.cluster.block

Class ClusterBlock

java.lang.Object

org.elasticsearch.cluster.block.ClusterBlock

All Implemented Interfaces:

Streamable, ToXContent, ToXContentFragment

public class ClusterBlock
extends java.lang.Object
implements Streamable, ToXContentFragment

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ClusterBlock(int id, java.lang.String description, boolean retryable, boolean disableStatePersistence, boolean allowReleaseResources, RestStatus status, java.util.EnumSet<ClusterBlockLevel> levels)
ClusterBlock(int id, java.lang.String uuid, java.lang.String description, boolean retryable, boolean disableStatePersistence, boolean allowReleaseResources, RestStatus status, java.util.EnumSet<ClusterBlockLevel> levels)

Method Summary

Modifier and Type	Method	Description
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()
boolean	isAllowReleaseResources()
java.util.EnumSet<ClusterBlockLevel>	levels()
static ClusterBlock	readClusterBlock(StreamInput in)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
boolean	retryable()	Should operations get into retry state if this block is present.
RestStatus	status()
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	uuid()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Detail

ClusterBlock

public ClusterBlock(int id,
                    java.lang.String description,
                    boolean retryable,
                    boolean disableStatePersistence,
                    boolean allowReleaseResources,
                    RestStatus status,
                    java.util.EnumSet<ClusterBlockLevel> levels)

ClusterBlock

public ClusterBlock(int id,
                    java.lang.String uuid,
                    java.lang.String description,
                    boolean retryable,
                    boolean disableStatePersistence,
                    boolean allowReleaseResources,
                    RestStatus status,
                    java.util.EnumSet<ClusterBlockLevel> levels)

Method Detail

id

public int id()

uuid

public java.lang.String uuid()

description

public java.lang.String description()

status

public RestStatus status()

levels

public java.util.EnumSet<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

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

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

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

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

isAllowReleaseResources

public boolean isAllowReleaseResources()