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
public class ClusterStateRequestBuilder extends MasterNodeReadOperationRequestBuilder<ClusterStateRequest,ClusterStateResponse,ClusterStateRequestBuilder>
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ClusterStateRequestBuilder(ElasticsearchClient client, ClusterStateAction action)
-
Method Summary
Modifier and Type Method Description ClusterStateRequestBuilder
all()
Include all dataClusterStateRequestBuilder
clear()
Do not include any dataClusterStateRequestBuilder
setBlocks(boolean filter)
ClusterStateRequestBuilder
setCustoms(boolean filter)
Should the cluster state result include theClusterState.Custom
.ClusterStateRequestBuilder
setIndices(java.lang.String... indices)
WhensetMetaData(boolean)
is set, which indices to return theIndexMetaData
for.ClusterStateRequestBuilder
setIndicesOptions(IndicesOptions indicesOptions)
ClusterStateRequestBuilder
setMetaData(boolean filter)
Should the cluster state result include theMetaData
.ClusterStateRequestBuilder
setNodes(boolean filter)
Should the cluster state result include theDiscoveryNodes
.ClusterStateRequestBuilder
setRoutingTable(boolean filter)
Should the cluster state result include theRoutingTable
.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)
IfClusterStateRequest.waitForMetaDataVersion()
is set then this determines how long to waitMethods inherited from class org.elasticsearch.action.support.master.MasterNodeReadOperationRequestBuilder
setLocal
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout
-
Constructor Details
-
Method Details
-
all
Include all data -
clear
Do not include any data -
setBlocks
-
setMetaData
Should the cluster state result include theMetaData
. Defaults totrue
. -
setNodes
Should the cluster state result include theDiscoveryNodes
. Defaults totrue
. -
setCustoms
Should the cluster state result include theClusterState.Custom
. Defaults totrue
. -
setRoutingTable
Should the cluster state result include theRoutingTable
. Defaults totrue
. -
setIndices
WhensetMetaData(boolean)
is set, which indices to return theIndexMetaData
for. Defaults to all indices. -
setIndicesOptions
-
setWaitForMetaDataVersion
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
IfClusterStateRequest.waitForMetaDataVersion()
is set then this determines how long to wait
-