Package org.opensearch.client.opensearch.ingest

Class SortProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<SortProcessor.Builder>

org.opensearch.client.opensearch.ingest.SortProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

SortProcessor

public static class SortProcessor.Builder
extends ProcessorBase.AbstractBuilder<SortProcessor.Builder>
implements CopyableBuilder<SortProcessor.Builder,SortProcessor>

Builder for SortProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SortProcessor	build()	Builds a SortProcessor.
SortProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SortProcessor.Builder	field(String value)	Required - API name: field
final SortProcessor.Builder	order(SortOrder value)	API name: order
protected SortProcessor.Builder	self()
final SortProcessor.Builder	targetField(String value)	API name: target_field

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder

description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag

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

Returns:

a new builder instance.

self

@Nonnull
protected SortProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<SortProcessor.Builder>

field

@Nonnull
public final SortProcessor.Builder field(String value)

Required - API name: field

order

@Nonnull
public final SortProcessor.Builder order(@Nullable
 SortOrder value)

API name: order

targetField

@Nonnull
public final SortProcessor.Builder targetField(@Nullable
 String value)

API name: target_field

build

@Nonnull
public SortProcessor build()

Builds a SortProcessor.

Specified by:

build in interface ObjectBuilder<SortProcessor>

Throws:

NullPointerException - if some of the required fields are null.