Class GetRecordsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetRecordsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class GetRecordsRequest extends RequestBase implements JsonpSerializable
Retrieves anomaly records for an anomaly detection job. Records contain the
detailed analytical results. They describe the anomalous activity that has
been identified in the input data based on the detector configuration. There
can be many anomaly records depending on the characteristics and size of the
input data. In practice, there are often too many to be able to manually
process them. The machine learning features therefore perform a sophisticated
aggregation of the anomaly records into buckets. The number of record results
depends on the number of anomalies found in each bucket, which relates to the
number of time series being modeled and the number of detectors.
- See Also:
- API specification
-
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,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_records
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
desc()
Refer to the description for thedesc
query parameter.java.lang.String
end()
Refer to the description for theend
query parameter.java.lang.Boolean
excludeInterim()
Refer to the description for theexclude_interim
query parameter.java.lang.Integer
from()
Skips the specified number of records.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.static GetRecordsRequest
of(java.util.function.Function<GetRecordsRequest.Builder,ObjectBuilder<GetRecordsRequest>> fn)
Page
page()
API name:page
java.lang.Double
recordScore()
Refer to the description for therecord_score
query parameter.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(ObjectDeserializer<GetRecordsRequest.Builder> op)
java.lang.Integer
size()
Specifies the maximum number of records to obtain.java.lang.String
sort()
Refer to the description for thesort
query parameter.java.lang.String
start()
Refer to the description for thestart
query parameter.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
".
-
-
Method Details
-
of
public static GetRecordsRequest of(java.util.function.Function<GetRecordsRequest.Builder,ObjectBuilder<GetRecordsRequest>> fn) -
desc
@Nullable public final java.lang.Boolean desc()Refer to the description for thedesc
query parameter.API name:
desc
-
end
@Nullable public final java.lang.String end()Refer to the description for theend
query parameter.API name:
end
-
excludeInterim
@Nullable public final java.lang.Boolean excludeInterim()Refer to the description for theexclude_interim
query parameter.API name:
exclude_interim
-
from
@Nullable public final java.lang.Integer from()Skips the specified number of records.API name:
from
-
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id
-
page
API name:page
-
recordScore
@Nullable public final java.lang.Double recordScore()Refer to the description for therecord_score
query parameter.API name:
record_score
-
size
@Nullable public final java.lang.Integer size()Specifies the maximum number of records to obtain.API name:
size
-
sort
@Nullable public final java.lang.String sort()Refer to the description for thesort
query parameter.API name:
sort
-
start
@Nullable public final java.lang.String start()Refer to the description for thestart
query parameter.API name:
start
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetRecordsRequestDeserializer
protected static void setupGetRecordsRequestDeserializer(ObjectDeserializer<GetRecordsRequest.Builder> op)
-