Class GetRecordsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetRecordsRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class GetRecordsRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetRecordsRequest.Builder
Builder forGetRecordsRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<GetRecordsRequest>
_DESERIALIZER
Json deserializer forGetRecordsRequest
static Endpoint<GetRecordsRequest,GetRecordsResponse,ElasticsearchError>
ENDPOINT
Endpoint "ml.get_records
". -
Constructor Summary
Constructors Constructor Description GetRecordsRequest(GetRecordsRequest.Builder builder)
GetRecordsRequest(java.util.function.Function<GetRecordsRequest.Builder,GetRecordsRequest.Builder> fn)
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
desc()
API name:desc
java.lang.String
end()
API name:end
java.lang.Boolean
excludeInterim()
API name:exclude_interim
java.lang.Integer
from()
skips a number of recordsjava.lang.String
jobId()
Required - The ID of the jobPage
page()
API name:page
java.lang.Double
recordScore()
API name:record_score
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupGetRecordsRequestDeserializer(DelegatingDeserializer<GetRecordsRequest.Builder> op)
java.lang.Integer
size()
specifies a max number of records to getjava.lang.String
sort()
API name:sort
java.lang.String
start()
API name:start
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forGetRecordsRequest
-
ENDPOINT
Endpoint "ml.get_records
".
-
-
Constructor Details
-
GetRecordsRequest
-
GetRecordsRequest
public GetRecordsRequest(java.util.function.Function<GetRecordsRequest.Builder,GetRecordsRequest.Builder> fn)
-
-
Method Details
-
jobId
public java.lang.String jobId()Required - The ID of the jobAPI name:
job_id
-
from
@Nullable public java.lang.Integer from()skips a number of recordsAPI name:
from
-
size
@Nullable public java.lang.Integer size()specifies a max number of records to getAPI name:
size
-
desc
@Nullable public java.lang.Boolean desc()API name:desc
-
excludeInterim
@Nullable public java.lang.Boolean excludeInterim()API name:exclude_interim
-
page
API name:page
-
recordScore
@Nullable public java.lang.Double recordScore()API name:record_score
-
sort
@Nullable public java.lang.String sort()API name:sort
-
start
@Nullable public java.lang.String start()API name:start
-
end
@Nullable public java.lang.String end()API name:end
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetRecordsRequestDeserializer
protected static void setupGetRecordsRequestDeserializer(DelegatingDeserializer<GetRecordsRequest.Builder> op)
-