Package org.opensearch.client.opensearch.ml

Class GetAllMemoriesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ml.GetAllMemoriesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetAllMemoriesRequest

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

Builder for GetAllMemoriesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetAllMemoriesRequest	build()	Builds a GetAllMemoriesRequest.
GetAllMemoriesRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
GetAllMemoriesRequest.Builder	maxResults(java.lang.Integer value)	The maximum number of results to return.
GetAllMemoriesRequest.Builder	nextToken(java.lang.Integer value)	The index of the first memory in the sorted list of memories to return.
protected GetAllMemoriesRequest.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, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public GetAllMemoriesRequest.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<GetAllMemoriesRequest.Builder,GetAllMemoriesRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetAllMemoriesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetAllMemoriesRequest.Builder>

maxResults

@Nonnull
public final GetAllMemoriesRequest.Builder maxResults(@Nullable
                                                      java.lang.Integer value)

The maximum number of results to return. If there are fewer memories than the number set in max_results, the response returns only the number of memories that exist. Default is 10.

API name: max_results

nextToken

@Nonnull
public final GetAllMemoriesRequest.Builder nextToken(@Nullable
                                                     java.lang.Integer value)

The index of the first memory in the sorted list of memories to return. Memories are ordered by create_time. For example, if memories A, B, and C exist, next_token=1 returns memories B and C. Default is 0 (return all memories).

API name: next_token

build

@Nonnull
public GetAllMemoriesRequest build()

Builds a GetAllMemoriesRequest.

Specified by:

build in interface ObjectBuilder<GetAllMemoriesRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.