Class GetAllMemoriesRequest
- java.lang.Object
-
- org.opensearch.client.opensearch._types.RequestBase
-
- org.opensearch.client.opensearch.ml.GetAllMemoriesRequest
-
- All Implemented Interfaces:
ToCopyableBuilder<GetAllMemoriesRequest.Builder,GetAllMemoriesRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class GetAllMemoriesRequest extends RequestBase implements ToCopyableBuilder<GetAllMemoriesRequest.Builder,GetAllMemoriesRequest>Get all memories.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetAllMemoriesRequest.BuilderBuilder forGetAllMemoriesRequest.-
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 Endpoint<GetAllMemoriesRequest,GetAllMemoriesResponse,ErrorResponse>_ENDPOINTEndpoint "ml.get_all_memories".
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidapplyQueryParameters(java.util.Map<java.lang.String,java.lang.String> params)static GetAllMemoriesRequest.Builderbuilder()booleanequals(java.lang.Object o)inthashCode()java.lang.IntegermaxResults()The maximum number of results to return.java.lang.IntegernextToken()The index of the first memory in the sorted list of memories to return.static GetAllMemoriesRequestof(java.util.function.Function<GetAllMemoriesRequest.Builder,ObjectBuilder<GetAllMemoriesRequest>> fn)GetAllMemoriesRequest.BuildertoBuilder()Create a new builderToCopyableBuilderthat is initialised with the current state of this object.-
Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
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 Detail
-
_ENDPOINT
public static final Endpoint<GetAllMemoriesRequest,GetAllMemoriesResponse,ErrorResponse> _ENDPOINT
Endpoint "ml.get_all_memories".
-
-
Method Detail
-
of
public static GetAllMemoriesRequest of(java.util.function.Function<GetAllMemoriesRequest.Builder,ObjectBuilder<GetAllMemoriesRequest>> fn)
-
maxResults
@Nullable public final java.lang.Integer maxResults()
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
@Nullable public final java.lang.Integer nextToken()
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
-
toBuilder
@Nonnull public GetAllMemoriesRequest.Builder toBuilder()
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetAllMemoriesRequest.Builder,GetAllMemoriesRequest>- Returns:
- a new builder instance.
-
builder
@Nonnull public static GetAllMemoriesRequest.Builder builder()
-
applyQueryParameters
protected void applyQueryParameters(@Nonnull java.util.Map<java.lang.String,java.lang.String> params)- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
-