Package org.opensearch.client.opensearch.ltr

Class SearchFeaturesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<SearchFeaturesRequest.Builder>

org.opensearch.client.opensearch.ltr.SearchFeaturesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SearchFeaturesRequest

public static class SearchFeaturesRequest.Builder
extends RequestBase.AbstractBuilder<SearchFeaturesRequest.Builder>
implements CopyableBuilder<SearchFeaturesRequest.Builder,SearchFeaturesRequest>

Builder for SearchFeaturesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchFeaturesRequest	build()	Builds a SearchFeaturesRequest.
SearchFeaturesRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SearchFeaturesRequest.Builder	from(Integer value)	The offset from the first result (for pagination).
final SearchFeaturesRequest.Builder	prefix(String value)	A name prefix to filter features by.
protected SearchFeaturesRequest.Builder	self()
final SearchFeaturesRequest.Builder	size(Integer value)	The number of features to return.
final SearchFeaturesRequest.Builder	store(String value)	The name of the feature store.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected SearchFeaturesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SearchFeaturesRequest.Builder>

from

@Nonnull
public final SearchFeaturesRequest.Builder from(@Nullable
 Integer value)

The offset from the first result (for pagination).

API name: from

prefix

@Nonnull
public final SearchFeaturesRequest.Builder prefix(@Nullable
 String value)

A name prefix to filter features by.

API name: prefix

size

@Nonnull
public final SearchFeaturesRequest.Builder size(@Nullable
 Integer value)

The number of features to return.

API name: size

store

@Nonnull
public final SearchFeaturesRequest.Builder store(@Nullable
 String value)

The name of the feature store.

API name: store

build

@Nonnull
public SearchFeaturesRequest build()

Builds a SearchFeaturesRequest.

Specified by:

build in interface ObjectBuilder<SearchFeaturesRequest>

Throws:

NullPointerException - if some of the required fields are null.