Package co.elastic.clients.elasticsearch.core.search

Class SourceFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SourceFilter.Builder>

co.elastic.clients.elasticsearch.core.search.SourceFilter.Builder

All Implemented Interfaces:

WithJson<SourceFilter.Builder>, ObjectBuilder<SourceFilter>

Enclosing class:

SourceFilter

public static class SourceFilter.Builder
extends WithJsonObjectBuilderBase<SourceFilter.Builder>
implements ObjectBuilder<SourceFilter>

Builder for SourceFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourceFilter	build()	Builds a SourceFilter.
final SourceFilter.Builder	excludes(String value, String... values)	A list of fields to exclude from the returned source.
final SourceFilter.Builder	excludes(List<String> list)	A list of fields to exclude from the returned source.
final SourceFilter.Builder	excludeVectors(Boolean value)	If true, vector fields are excluded from the returned source.
final SourceFilter.Builder	includes(String value, String... values)	A list of fields to include in the returned source.
final SourceFilter.Builder	includes(List<String> list)	A list of fields to include in the returned source.
protected SourceFilter.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

excludeVectors

public final SourceFilter.Builder excludeVectors(@Nullable
 Boolean value)

If true, vector fields are excluded from the returned source.

This option takes precedence over includes: any vector field will remain excluded even if it matches an includes rule.

API name: exclude_vectors

excludes

public final SourceFilter.Builder excludes(List<String> list)

A list of fields to exclude from the returned source.

API name: excludes

Adds all elements of list to excludes.

excludes

public final SourceFilter.Builder excludes(String value,
 String... values)

A list of fields to exclude from the returned source.

API name: excludes

Adds one or more values to excludes.

includes

public final SourceFilter.Builder includes(List<String> list)

A list of fields to include in the returned source.

API name: includes

Adds all elements of list to includes.

includes

public final SourceFilter.Builder includes(String value,
 String... values)

A list of fields to include in the returned source.

API name: includes

Adds one or more values to includes.

self

protected SourceFilter.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SourceFilter.Builder>

build

public SourceFilter build()

Builds a SourceFilter.

Specified by:

build in interface ObjectBuilder<SourceFilter>

Throws:

NullPointerException - if some of the required fields are null.