Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.state

Class ClusterStateRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder<ClusterStateRequest,ClusterStateResponse,ClusterStateRequestBuilder>

org.elasticsearch.action.admin.cluster.state.ClusterStateRequestBuilder

All Implemented Interfaces:

RequestBuilder<ClusterStateRequest,ClusterStateResponse>

public class ClusterStateRequestBuilder
extends MasterNodeReadOperationRequestBuilder<ClusterStateRequest,ClusterStateResponse,ClusterStateRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
ClusterStateRequestBuilder(ElasticsearchClient client)

Method Summary

Modifier and Type	Method	Description
ClusterStateRequestBuilder	all()	Include all data
ClusterStateRequestBuilder	clear()	Do not include any data
ClusterStateRequestBuilder	setBlocks(boolean filter)
ClusterStateRequestBuilder	setCustoms(boolean filter)	Should the cluster state result include the ClusterState.Custom.
ClusterStateRequestBuilder	setIndices(String... indices)	When setMetadata(boolean) is set, which indices to return the IndexMetadata for.
ClusterStateRequestBuilder	setIndicesOptions(IndicesOptions indicesOptions)
ClusterStateRequestBuilder	setMetadata(boolean filter)	Should the cluster state result include the Metadata.
ClusterStateRequestBuilder	setNodes(boolean filter)	Should the cluster state result include the DiscoveryNodes.
ClusterStateRequestBuilder	setRoutingTable(boolean filter)	Should the cluster state result include the RoutingTable.
ClusterStateRequestBuilder	setWaitForMetadataVersion(long waitForMetadataVersion)	Causes the request to wait for the metadata version to advance to at least the given version.
ClusterStateRequestBuilder	setWaitForTimeOut(TimeValue waitForTimeout)	If ClusterStateRequest.waitForMetadataVersion() is set then this determines how long to wait

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder

setLocal

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

ClusterStateRequestBuilder

public ClusterStateRequestBuilder(ElasticsearchClient client)

Method Details

all

public ClusterStateRequestBuilder all()

Include all data

clear

public ClusterStateRequestBuilder clear()

Do not include any data

setBlocks

public ClusterStateRequestBuilder setBlocks(boolean filter)

setMetadata

public ClusterStateRequestBuilder setMetadata(boolean filter)

Should the cluster state result include the Metadata. Defaults to true.

setNodes

public ClusterStateRequestBuilder setNodes(boolean filter)

Should the cluster state result include the DiscoveryNodes. Defaults to true.

setCustoms

public ClusterStateRequestBuilder setCustoms(boolean filter)

Should the cluster state result include the ClusterState.Custom. Defaults to true.

setRoutingTable

public ClusterStateRequestBuilder setRoutingTable(boolean filter)

Should the cluster state result include the RoutingTable. Defaults to true.

setIndices

public ClusterStateRequestBuilder setIndices(String... indices)

When setMetadata(boolean) is set, which indices to return the IndexMetadata for. Defaults to all indices.

setIndicesOptions

public ClusterStateRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)

setWaitForMetadataVersion

public ClusterStateRequestBuilder setWaitForMetadataVersion(long waitForMetadataVersion)

Causes the request to wait for the metadata version to advance to at least the given version.

Parameters:

waitForMetadataVersion - The metadata version for which to wait

setWaitForTimeOut

public ClusterStateRequestBuilder setWaitForTimeOut(TimeValue waitForTimeout)

If ClusterStateRequest.waitForMetadataVersion() is set then this determines how long to wait