Package org.opensearch.client.opensearch.search_relevance

Class GetSearchConfigurationsResponse.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.search_relevance.GetSearchConfigurationsResponse.Builder<TDocument>

All Implemented Interfaces:

CopyableBuilder<GetSearchConfigurationsResponse.Builder<TDocument>,GetSearchConfigurationsResponse<TDocument>>, MutableBuilder<GetSearchConfigurationsResponse.Builder<TDocument>,GetSearchConfigurationsResponse<TDocument>>, ObjectBuilder<GetSearchConfigurationsResponse<TDocument>>

Enclosing class:

GetSearchConfigurationsResponse<TDocument>

public static class GetSearchConfigurationsResponse.Builder<TDocument>
extends ObjectBuilderBase
implements CopyableBuilder<GetSearchConfigurationsResponse.Builder<TDocument>,GetSearchConfigurationsResponse<TDocument>>

Builder for GetSearchConfigurationsResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetSearchConfigurationsResponse.Builder<TDocument>	aggregations(String key, Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)	API name: aggregations
final GetSearchConfigurationsResponse.Builder<TDocument>	aggregations(String key, Aggregate value)	API name: aggregations
final GetSearchConfigurationsResponse.Builder<TDocument>	aggregations(Map<String,Aggregate> map)	API name: aggregations
GetSearchConfigurationsResponse<TDocument>	build()	Builds a GetSearchConfigurationsResponse.
final GetSearchConfigurationsResponse.Builder<TDocument>	clusters(Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)	API name: _clusters
final GetSearchConfigurationsResponse.Builder<TDocument>	clusters(ClusterStatistics value)	API name: _clusters
GetSearchConfigurationsResponse.Builder<TDocument>	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetSearchConfigurationsResponse.Builder<TDocument>	fields(String key, JsonData value)	API name: fields
final GetSearchConfigurationsResponse.Builder<TDocument>	fields(Map<String,JsonData> map)	API name: fields
final GetSearchConfigurationsResponse.Builder<TDocument>	hits(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)	Required - API name: hits
final GetSearchConfigurationsResponse.Builder<TDocument>	hits(HitsMetadata<TDocument> value)	Required - API name: hits
final GetSearchConfigurationsResponse.Builder<TDocument>	numReducePhases(Integer value)	API name: num_reduce_phases
final GetSearchConfigurationsResponse.Builder<TDocument>	phaseTook(Function<PhaseTook.Builder,ObjectBuilder<PhaseTook>> fn)	API name: phase_took
final GetSearchConfigurationsResponse.Builder<TDocument>	phaseTook(PhaseTook value)	API name: phase_took
final GetSearchConfigurationsResponse.Builder<TDocument>	pitId(String value)	API name: pit_id
final GetSearchConfigurationsResponse.Builder<TDocument>	processorResults(Function<ProcessorExecutionDetail.Builder,ObjectBuilder<ProcessorExecutionDetail>> fn)	API name: processor_results
final GetSearchConfigurationsResponse.Builder<TDocument>	processorResults(List<ProcessorExecutionDetail> list)	API name: processor_results
final GetSearchConfigurationsResponse.Builder<TDocument>	processorResults(ProcessorExecutionDetail value, ProcessorExecutionDetail... values)	API name: processor_results
final GetSearchConfigurationsResponse.Builder<TDocument>	profile(Function<Profile.Builder,ObjectBuilder<Profile>> fn)	API name: profile
final GetSearchConfigurationsResponse.Builder<TDocument>	profile(Profile value)	API name: profile
final GetSearchConfigurationsResponse.Builder<TDocument>	scrollId(String value)	API name: _scroll_id
final GetSearchConfigurationsResponse.Builder<TDocument>	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - API name: _shards
final GetSearchConfigurationsResponse.Builder<TDocument>	shards(ShardStatistics value)	Required - API name: _shards
final GetSearchConfigurationsResponse.Builder<TDocument>	suggest(String key, List<Suggest<JsonData>> value)	API name: suggest
final GetSearchConfigurationsResponse.Builder<TDocument>	suggest(Map<String,List<Suggest<JsonData>>> map)	API name: suggest
final GetSearchConfigurationsResponse.Builder<TDocument>	terminatedEarly(Boolean value)	API name: terminated_early
final GetSearchConfigurationsResponse.Builder<TDocument>	timedOut(boolean value)	Required - API name: timed_out
final GetSearchConfigurationsResponse.Builder<TDocument>	took(long value)	Required - API name: took

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetSearchConfigurationsResponse.Builder<TDocument> copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetSearchConfigurationsResponse.Builder<TDocument>,GetSearchConfigurationsResponse<TDocument>>

Returns:

a new builder instance.

aggregations

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> aggregations(Map<String,Aggregate> map)

API name: aggregations

Adds all elements of map to aggregations.

aggregations

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> aggregations(String key,
 Aggregate value)

API name: aggregations

Adds an entry to aggregations.

aggregations

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> aggregations(String key,
 Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)

API name: aggregations

Adds a value to aggregations using a builder lambda.

clusters

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> clusters(@Nullable
 ClusterStatistics value)

API name: _clusters

clusters

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> clusters(Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)

API name: _clusters

fields

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> fields(Map<String,JsonData> map)

API name: fields

Adds all elements of map to fields.

fields

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> fields(String key,
 JsonData value)

API name: fields

Adds an entry to fields.

hits

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> hits(HitsMetadata<TDocument> value)

Required - API name: hits

hits

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> hits(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)

Required - API name: hits

numReducePhases

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> numReducePhases(@Nullable
 Integer value)

API name: num_reduce_phases

phaseTook

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> phaseTook(@Nullable
 PhaseTook value)

API name: phase_took

phaseTook

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> phaseTook(Function<PhaseTook.Builder,ObjectBuilder<PhaseTook>> fn)

API name: phase_took

pitId

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> pitId(@Nullable
 String value)

API name: pit_id

processorResults

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> processorResults(List<ProcessorExecutionDetail> list)

API name: processor_results

Adds all elements of list to processorResults.

processorResults

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> processorResults(ProcessorExecutionDetail value,
 ProcessorExecutionDetail... values)

API name: processor_results

Adds one or more values to processorResults.

processorResults

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> processorResults(Function<ProcessorExecutionDetail.Builder,ObjectBuilder<ProcessorExecutionDetail>> fn)

API name: processor_results

Adds a value to processorResults using a builder lambda.

profile

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> profile(@Nullable
 Profile value)

API name: profile

profile

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> profile(Function<Profile.Builder,ObjectBuilder<Profile>> fn)

API name: profile

scrollId

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> scrollId(@Nullable
 String value)

API name: _scroll_id

shards

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> shards(ShardStatistics value)

Required - API name: _shards

shards

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

Required - API name: _shards

suggest

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> suggest(Map<String,List<Suggest<JsonData>>> map)

API name: suggest

Adds all elements of map to suggest.

suggest

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> suggest(String key,
 List<Suggest<JsonData>> value)

API name: suggest

Adds an entry to suggest.

terminatedEarly

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> terminatedEarly(@Nullable
 Boolean value)

API name: terminated_early

timedOut

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> timedOut(boolean value)

Required - API name: timed_out

took

@Nonnull
public final GetSearchConfigurationsResponse.Builder<TDocument> took(long value)

Required - API name: took

build

@Nonnull
public GetSearchConfigurationsResponse<TDocument> build()

Builds a GetSearchConfigurationsResponse.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.