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:

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

Enclosing class:

SourceFilter

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

Builder for SourceFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourceFilter	build()	Builds a SourceFilter.
SourceFilter.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SourceFilter.Builder	excludes(String value, String... values)	API name: excludes
final SourceFilter.Builder	excludes(List<String> list)	API name: excludes
final SourceFilter.Builder	includes(String value, String... values)	API name: includes
final SourceFilter.Builder	includes(List<String> list)	API name: includes

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 SourceFilter.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<SourceFilter.Builder,SourceFilter>

Returns:

a new builder instance.

excludes

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

API name: excludes

Adds all elements of list to excludes.

excludes

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

API name: excludes

Adds one or more values to excludes.

includes

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

API name: includes

Adds all elements of list to includes.

includes

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

API name: includes

Adds one or more values to includes.

build

@Nonnull
public SourceFilter build()

Builds a SourceFilter.

Specified by:

build in interface ObjectBuilder<SourceFilter>

Throws:

NullPointerException - if some of the required fields are null.