Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class SearchResponse.Cluster.Builder

java.lang.Object

org.elasticsearch.action.search.SearchResponse.Cluster.Builder

Enclosing class:

SearchResponse.Cluster

public static class SearchResponse.Cluster.Builder
extends Object

Since the Cluster object is immutable, use this Builder class to create a new Cluster object using the "copyFrom" Cluster passed in and set only changed values. Since the clusterAlias, indexExpression and skipUnavailable fields are never changed once set, this Builder provides no setter method for them. All other fields can be set and override the value in the "copyFrom" Cluster.

Constructor Summary

Constructors

Constructor	Description
Builder(SearchResponse.Cluster copyFrom)

Method Summary

Modifier and Type	Method	Description
SearchResponse.Cluster	build()
SearchResponse.Cluster.Builder	setFailedShards(int failedShards)
SearchResponse.Cluster.Builder	setFailures(List<ShardSearchFailure> failures)
SearchResponse.Cluster.Builder	setSkippedShards(int skippedShards)
SearchResponse.Cluster.Builder	setStatus(SearchResponse.Cluster.Status status)
SearchResponse.Cluster.Builder	setSuccessfulShards(int successfulShards)
SearchResponse.Cluster.Builder	setTimedOut(boolean timedOut)
SearchResponse.Cluster.Builder	setTook(TimeValue took)
SearchResponse.Cluster.Builder	setTotalShards(int totalShards)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(SearchResponse.Cluster copyFrom)

Method Details

build

public SearchResponse.Cluster build()

Returns:

new Cluster object using the new values passed in via setters or the values in the "copyFrom" Cluster object set in the Builder constructor.

setStatus

public SearchResponse.Cluster.Builder setStatus(SearchResponse.Cluster.Status status)

setTotalShards

public SearchResponse.Cluster.Builder setTotalShards(int totalShards)

setSuccessfulShards

public SearchResponse.Cluster.Builder setSuccessfulShards(int successfulShards)

setSkippedShards

public SearchResponse.Cluster.Builder setSkippedShards(int skippedShards)

setFailedShards

public SearchResponse.Cluster.Builder setFailedShards(int failedShards)

setFailures

public SearchResponse.Cluster.Builder setFailures(List<ShardSearchFailure> failures)

setTook

public SearchResponse.Cluster.Builder setTook(TimeValue took)

setTimedOut

public SearchResponse.Cluster.Builder setTimedOut(boolean timedOut)