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

Class SourceFilter.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SourceFilter.Builder

All Implemented Interfaces:

ObjectBuilder<SourceFilter>

Enclosing class:

SourceFilter

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

Builder for SourceFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourceFilter	build()	Builds a SourceFilter.
SourceFilter.Builder	excludes(java.lang.String value, java.lang.String... values)	API name: excludes
SourceFilter.Builder	excludes(java.util.List<java.lang.String> list)	API name: excludes
SourceFilter.Builder	includes(java.lang.String value, java.lang.String... values)	API name: includes
SourceFilter.Builder	includes(java.util.List<java.lang.String> list)	API name: includes

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

excludes

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

API name: excludes

Adds all elements of list to excludes.

excludes

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

API name: excludes

Adds one or more values to excludes.

includes

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

API name: includes

Adds all elements of list to includes.

includes

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

API name: includes

Adds one or more values to includes.

build

public SourceFilter build()

Builds a SourceFilter.

Specified by:

build in interface ObjectBuilder<SourceFilter>

Throws:

java.lang.NullPointerException - if some of the required fields are null.