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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetInfluencersRequest.Builder
Builder forGetInfluencersRequest
.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<GetInfluencersRequest>
_DESERIALIZER
Json deserializer forGetInfluencersRequest
static Endpoint<GetInfluencersRequest,GetInfluencersResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_influencers
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
desc()
If true, the results are sorted in descending order.java.lang.String
end()
Returns influencers with timestamps earlier than this time.java.lang.Boolean
excludeInterim()
If true, the output excludes interim results.java.lang.Integer
from()
Skips the specified number of influencers.java.lang.Double
influencerScore()
Returns influencers with anomaly scores greater than or equal to this value.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.static GetInfluencersRequest
of(java.util.function.Function<GetInfluencersRequest.Builder,ObjectBuilder<GetInfluencersRequest>> fn)
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
setupGetInfluencersRequestDeserializer(ObjectDeserializer<GetInfluencersRequest.Builder> op)
java.lang.Integer
size()
Specifies the maximum number of influencers to obtain.java.lang.String
sort()
Specifies the sort field for the requested influencers.java.lang.String
start()
Returns influencers with timestamps after this time.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forGetInfluencersRequest
-
_ENDPOINT
public static final Endpoint<GetInfluencersRequest,GetInfluencersResponse,ErrorResponse> _ENDPOINTEndpoint "ml.get_influencers
".
-
-
Method Details
-
of
public static GetInfluencersRequest of(java.util.function.Function<GetInfluencersRequest.Builder,ObjectBuilder<GetInfluencersRequest>> fn) -
desc
@Nullable public final java.lang.Boolean desc()If true, the results are sorted in descending order.API name:
desc
-
end
@Nullable public final java.lang.String 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
@Nullable public final java.lang.Boolean excludeInterim()If true, the output excludes interim results. By default, interim results are included.API name:
exclude_interim
-
from
@Nullable public final java.lang.Integer from()Skips the specified number of influencers.API name:
from
-
influencerScore
@Nullable public final java.lang.Double influencerScore()Returns influencers with anomaly scores greater than or equal to this value.API name:
influencer_score
-
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id
-
page
API name:page
-
size
@Nullable public final java.lang.Integer size()Specifies the maximum number of influencers to obtain.API name:
size
-
sort
@Nullable public final java.lang.String sort()Specifies the sort field for the requested influencers. By default, the influencers are sorted by theinfluencer_score
value.API name:
sort
-
start
@Nullable public final java.lang.String 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)
-