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 forGetAllMemoriesRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetAllMemoriesRequestbuild()Builds aGetAllMemoriesRequest.GetAllMemoriesRequest.Buildercopy()Create a new builderCopyableBuilderthat is a copy of this one.GetAllMemoriesRequest.BuildermaxResults(java.lang.Integer value)The maximum number of results to return.GetAllMemoriesRequest.BuildernextToken(java.lang.Integer value)The index of the first memory in the sorted list of memories to return.protected GetAllMemoriesRequest.Builderself()-
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
-
-
-
-
Method Detail
-
copy
@Nonnull public GetAllMemoriesRequest.Builder copy()
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<GetAllMemoriesRequest.Builder,GetAllMemoriesRequest>- Returns:
- a new builder instance.
-
self
@Nonnull protected GetAllMemoriesRequest.Builder self()
- Specified by:
selfin classRequestBase.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 inmax_results, the response returns only the number of memories that exist. Default is10.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 bycreate_time. For example, if memoriesA,B, andCexist,next_token=1returns memoriesBandC. Default is0(return all memories).API name:
next_token
-
build
@Nonnull public GetAllMemoriesRequest build()
Builds aGetAllMemoriesRequest.- Specified by:
buildin interfaceObjectBuilder<GetAllMemoriesRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-