Package org.opensearch.client.opensearch.knn

Class WarmupRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.knn.WarmupRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

WarmupRequest

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

Builder for WarmupRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WarmupRequest	build()	Builds a WarmupRequest.
WarmupRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final WarmupRequest.Builder	index(String value, String... values)	Required - A comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
final WarmupRequest.Builder	index(List<String> list)	Required - A comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
protected WarmupRequest.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected WarmupRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<WarmupRequest.Builder>

index

@Nonnull
public final WarmupRequest.Builder index(List<String> list)

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

API name: index

Adds all elements of list to index.

index

@Nonnull
public final WarmupRequest.Builder index(String value,
 String... values)

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

API name: index

Adds one or more values to index.

build

@Nonnull
public WarmupRequest build()

Builds a WarmupRequest.

Specified by:

build in interface ObjectBuilder<WarmupRequest>

Throws:

NullPointerException - if some of the required fields are null.