Class GetStatusResponse
java.lang.Object
co.elastic.clients.elasticsearch.eql.GetStatusResponse
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public final class GetStatusResponse extends java.lang.Object implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetStatusResponse.BuilderBuilder forGetStatusResponse. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<GetStatusResponse>_DESERIALIZERJson deserializer forGetStatusResponse -
Constructor Summary
Constructors Constructor Description GetStatusResponse(GetStatusResponse.Builder builder)GetStatusResponse(java.util.function.Function<GetStatusResponse.Builder,GetStatusResponse.Builder> fn) -
Method Summary
Modifier and Type Method Description java.lang.IntegercompletionStatus()For a completed search shows the http status code of the completed search.java.lang.StringexpirationTimeInMillis()Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch.java.lang.Stringid()Required - Identifier for the search.booleanisPartial()Required - If true, the search request is still executing.booleanisRunning()Required - If true, the response does not contain complete search results.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupGetStatusResponseDeserializer(DelegatingDeserializer<GetStatusResponse.Builder> op)java.lang.StringstartTimeInMillis()For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forGetStatusResponse
-
-
Constructor Details
-
GetStatusResponse
-
GetStatusResponse
public GetStatusResponse(java.util.function.Function<GetStatusResponse.Builder,GetStatusResponse.Builder> fn)
-
-
Method Details
-
id
public java.lang.String id()Required - Identifier for the search.API name:
id -
isPartial
public boolean isPartial()Required - If true, the search request is still executing. If false, the search is completed.API name:
is_partial -
isRunning
public boolean isRunning()Required - If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.API name:
is_running -
startTimeInMillis
@Nullable public java.lang.String startTimeInMillis()For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.API name:
start_time_in_millis -
expirationTimeInMillis
@Nullable public java.lang.String expirationTimeInMillis()Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing.API name:
expiration_time_in_millis -
completionStatus
@Nullable public java.lang.Integer completionStatus()For a completed search shows the http status code of the completed search.API name:
completion_status -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupGetStatusResponseDeserializer
protected static void setupGetStatusResponseDeserializer(DelegatingDeserializer<GetStatusResponse.Builder> op)
-