Package org.opensearch.client.opensearch._types

Class DerivedField.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.DerivedField.Builder

All Implemented Interfaces:

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

Enclosing class:

DerivedField

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

Builder for DerivedField.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DerivedField	build()	Builds a DerivedField.
DerivedField.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DerivedField.Builder	format(String value)	API name: format
final DerivedField.Builder	ignoreMalformed(Boolean value)	API name: ignore_malformed
final DerivedField.Builder	name(String value)	Required - API name: name
final DerivedField.Builder	prefilterField(String value)	API name: prefilter_field
final DerivedField.Builder	properties(String key, JsonData value)	API name: properties
final DerivedField.Builder	properties(Map<String,JsonData> map)	API name: properties
final DerivedField.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	Required - API name: script
final DerivedField.Builder	script(Script value)	Required - API name: script
final DerivedField.Builder	type(String value)	Required - API name: type

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

Returns:

a new builder instance.

format

@Nonnull
public final DerivedField.Builder format(@Nullable
 String value)

API name: format

ignoreMalformed

@Nonnull
public final DerivedField.Builder ignoreMalformed(@Nullable
 Boolean value)

API name: ignore_malformed

name

@Nonnull
public final DerivedField.Builder name(String value)

Required - API name: name

prefilterField

@Nonnull
public final DerivedField.Builder prefilterField(@Nullable
 String value)

API name: prefilter_field

properties

@Nonnull
public final DerivedField.Builder properties(Map<String,JsonData> map)

API name: properties

Adds all elements of map to properties.

properties

@Nonnull
public final DerivedField.Builder properties(String key,
 JsonData value)

API name: properties

Adds an entry to properties.

script

@Nonnull
public final DerivedField.Builder script(Script value)

Required - API name: script

script

@Nonnull
public final DerivedField.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

Required - API name: script

type

@Nonnull
public final DerivedField.Builder type(String value)

Required - API name: type

build

@Nonnull
public DerivedField build()

Builds a DerivedField.

Specified by:

build in interface ObjectBuilder<DerivedField>

Throws:

NullPointerException - if some of the required fields are null.