Package org.opensearch.client.opensearch.knn

Class WarmupRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.knn.WarmupRequest

All Implemented Interfaces:

ToCopyableBuilder<WarmupRequest.Builder,WarmupRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class WarmupRequest
extends RequestBase
implements ToCopyableBuilder<WarmupRequest.Builder,WarmupRequest>

Preloads native library files into memory, reducing initial search latency for specified indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WarmupRequest.Builder	Builder for WarmupRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<WarmupRequest,WarmupResponse,ErrorResponse>	_ENDPOINT	Endpoint "knn.warmup".

Method Summary

Modifier and Type	Method	Description
static WarmupRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	index()	Required - A comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
static WarmupRequest	of(Function<WarmupRequest.Builder,ObjectBuilder<WarmupRequest>> fn)
WarmupRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<WarmupRequest,WarmupResponse,ErrorResponse> _ENDPOINT

Endpoint "knn.warmup".

Method Details

of

public static WarmupRequest of(Function<WarmupRequest.Builder,ObjectBuilder<WarmupRequest>> fn)

index

@Nonnull
public final List<String> index()

Required - A comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.

API name: index

toBuilder

@Nonnull
public WarmupRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<WarmupRequest.Builder,WarmupRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static WarmupRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object