Package org.elasticsearch.cluster.block

Class ClusterBlock

java.lang.Object

org.elasticsearch.cluster.block.ClusterBlock

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class ClusterBlock
extends Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ClusterBlock(int id, String description, boolean retryable, boolean disableStatePersistence, boolean allowReleaseResources, RestStatus status, EnumSet<ClusterBlockLevel> levels)
ClusterBlock(int id, String uuid, String description, boolean retryable, boolean disableStatePersistence, boolean allowReleaseResources, RestStatus status, EnumSet<ClusterBlockLevel> levels)
ClusterBlock(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	contains(ClusterBlockLevel level)
String	description()
boolean	disableStatePersistence()	Should global state persistence be disabled when this block is present.
boolean	equals(Object o)
int	hashCode()
int	id()
boolean	isAllowReleaseResources()
EnumSet<ClusterBlockLevel>	levels()
boolean	retryable()	Should operations get into retry state if this block is present.
RestStatus	status()
String	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
String	uuid()
void	writeTo(StreamOutput out)	Write this into the 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 Details

ClusterBlock

public ClusterBlock(StreamInput in)
             throws IOException

Throws:

IOException

ClusterBlock

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

ClusterBlock

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

Method Details

id

public int id()

uuid

@Nullable
public String uuid()

description

public String description()

status

public RestStatus status()

levels

public 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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAllowReleaseResources

public boolean isAllowReleaseResources()