Class GetInfluencersRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetInfluencersRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class GetInfluencersRequest
extends RequestBase
implements JsonpSerializable
Retrieves anomaly detection job results for one or more influencers.
Influencers are the entities that have contributed to, or are to blame for,
the anomalies. Influencer results are available only if an
influencer_field_name
is specified in the job configuration.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GetInfluencersRequest>
Json deserializer forGetInfluencersRequest
static final Endpoint<GetInfluencersRequest,
GetInfluencersResponse, ErrorResponse> Endpoint "ml.get_influencers
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
desc()
If true, the results are sorted in descending order.final DateTime
end()
Returns influencers with timestamps earlier than this time.final Boolean
If true, the output excludes interim results.final Integer
from()
Skips the specified number of influencers.final Double
Returns influencers with anomaly scores greater than or equal to this value.final String
jobId()
Required - Identifier for the anomaly detection job.static GetInfluencersRequest
final Page
page()
API name:page
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
final Integer
size()
Specifies the maximum number of influencers to obtain.final String
sort()
Specifies the sort field for the requested influencers.final DateTime
start()
Returns influencers with timestamps after this time.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forGetInfluencersRequest
-
_ENDPOINT
Endpoint "ml.get_influencers
".
-
-
Method Details
-
of
public static GetInfluencersRequest of(Function<GetInfluencersRequest.Builder, ObjectBuilder<GetInfluencersRequest>> fn) -
desc
If true, the results are sorted in descending order.API name:
desc
-
end
Returns influencers with timestamps earlier than this time. The default value means it is unset and results are not limited to specific timestamps.API name:
end
-
excludeInterim
If true, the output excludes interim results. By default, interim results are included.API name:
exclude_interim
-
from
Skips the specified number of influencers.API name:
from
-
influencerScore
Returns influencers with anomaly scores greater than or equal to this value.API name:
influencer_score
-
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
page
API name:page
-
size
Specifies the maximum number of influencers to obtain.API name:
size
-
sort
Specifies the sort field for the requested influencers. By default, the influencers are sorted by theinfluencer_score
value.API name:
sort
-
start
Returns influencers with timestamps after this time. The default value means it is unset and results are not limited to specific timestamps.API name:
start
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetInfluencersRequestDeserializer
protected static void setupGetInfluencersRequestDeserializer(ObjectDeserializer<GetInfluencersRequest.Builder> op)
-