Package org.opensearch.client.opensearch.search_pipeline

Class SortResponseProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.search_pipeline.SortResponseProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

SortResponseProcessor

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

Builder for SortResponseProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SortResponseProcessor	build()	Builds a SortResponseProcessor.
SortResponseProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SortResponseProcessor.Builder	description(String value)	API name: description
final SortResponseProcessor.Builder	field(String value)	Required - API name: field
final SortResponseProcessor.Builder	ignoreFailure(Boolean value)	API name: ignore_failure
final SortResponseProcessor.Builder	order(String value)	API name: order
final SortResponseProcessor.Builder	tag(String value)	API name: tag
final SortResponseProcessor.Builder	targetField(String value)	API name: target_field

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

Returns:

a new builder instance.

description

@Nonnull
public final SortResponseProcessor.Builder description(@Nullable
 String value)

API name: description

field

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

Required - API name: field

ignoreFailure

@Nonnull
public final SortResponseProcessor.Builder ignoreFailure(@Nullable
 Boolean value)

API name: ignore_failure

order

@Nonnull
public final SortResponseProcessor.Builder order(@Nullable
 String value)

API name: order

tag

@Nonnull
public final SortResponseProcessor.Builder tag(@Nullable
 String value)

API name: tag

targetField

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

API name: target_field

build

@Nonnull
public SortResponseProcessor build()

Builds a SortResponseProcessor.

Specified by:

build in interface ObjectBuilder<SortResponseProcessor>

Throws:

NullPointerException - if some of the required fields are null.