Package org.opensearch.client.opensearch.ltr

Class SearchModelsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ltr.SearchModelsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SearchModelsRequest

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

Builder for SearchModelsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchModelsRequest	build()	Builds a SearchModelsRequest.
SearchModelsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SearchModelsRequest.Builder	from(Integer value)	The offset from the first result (for pagination).
final SearchModelsRequest.Builder	prefix(String value)	A name prefix to filter models by.
protected SearchModelsRequest.Builder	self()
final SearchModelsRequest.Builder	size(Integer value)	The number of models to return.
final SearchModelsRequest.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 SearchModelsRequest.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<SearchModelsRequest.Builder,SearchModelsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SearchModelsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SearchModelsRequest.Builder>

from

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

The offset from the first result (for pagination).

API name: from

prefix

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

A name prefix to filter models by.

API name: prefix

size

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

The number of models to return.

API name: size

store

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

The name of the feature store.

API name: store

build

@Nonnull
public SearchModelsRequest build()

Builds a SearchModelsRequest.

Specified by:

build in interface ObjectBuilder<SearchModelsRequest>

Throws:

NullPointerException - if some of the required fields are null.