Package org.opensearch.client.opensearch.core.search

Class CompletionContext.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.CompletionContext.Builder

All Implemented Interfaces:

CopyableBuilder<CompletionContext.Builder,CompletionContext>, MutableBuilder<CompletionContext.Builder,CompletionContext>, ObjectBuilder<CompletionContext>

Enclosing class:

CompletionContext

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

Builder for CompletionContext.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CompletionContext.Builder	boost(Double value)	API name: boost
CompletionContext	build()	Builds a CompletionContext.
final CompletionContext.Builder	context(Function<Context.Builder,ObjectBuilder<Context>> fn)	Required - API name: context
final CompletionContext.Builder	context(Context value)	Required - API name: context
CompletionContext.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CompletionContext.Builder	neighbours(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)	API name: neighbours
final CompletionContext.Builder	neighbours(List<GeoHashPrecision> list)	API name: neighbours
final CompletionContext.Builder	neighbours(GeoHashPrecision value, GeoHashPrecision... values)	API name: neighbours
final CompletionContext.Builder	precision(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)	API name: precision
final CompletionContext.Builder	precision(GeoHashPrecision value)	API name: precision
final CompletionContext.Builder	prefix(Boolean value)	API name: prefix

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 CompletionContext.Builder copy()

Description copied from interface: CopyableBuilder

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

Specified by:

copy in interface CopyableBuilder<CompletionContext.Builder,CompletionContext>

Returns:

a new builder instance.

boost

@Nonnull
public final CompletionContext.Builder boost(@Nullable
 Double value)

API name: boost

context

@Nonnull
public final CompletionContext.Builder context(Context value)

Required - API name: context

context

@Nonnull
public final CompletionContext.Builder context(Function<Context.Builder,ObjectBuilder<Context>> fn)

Required - API name: context

neighbours

@Nonnull
public final CompletionContext.Builder neighbours(List<GeoHashPrecision> list)

API name: neighbours

Adds all elements of list to neighbours.

neighbours

@Nonnull
public final CompletionContext.Builder neighbours(GeoHashPrecision value,
 GeoHashPrecision... values)

API name: neighbours

Adds one or more values to neighbours.

neighbours

@Nonnull
public final CompletionContext.Builder neighbours(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)

API name: neighbours

Adds a value to neighbours using a builder lambda.

precision

@Nonnull
public final CompletionContext.Builder precision(@Nullable
 GeoHashPrecision value)

API name: precision

precision

@Nonnull
public final CompletionContext.Builder precision(Function<GeoHashPrecision.Builder,ObjectBuilder<GeoHashPrecision>> fn)

API name: precision

prefix

@Nonnull
public final CompletionContext.Builder prefix(@Nullable
 Boolean value)

API name: prefix

build

@Nonnull
public CompletionContext build()

Builds a CompletionContext.

Specified by:

build in interface ObjectBuilder<CompletionContext>

Throws:

NullPointerException - if some of the required fields are null.