Class AsyncSearchResponseBase
java.lang.Object
co.elastic.clients.elasticsearch.async_search.AsyncSearchResponseBase
- All Implemented Interfaces:
JsonpSerializable
- Direct Known Subclasses:
AsyncSearchDocumentResponseBase
,StatusResponseBase
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
AsyncSearchResponseBase.AbstractBuilder<BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>>
-
Constructor Summary
ModifierConstructorDescriptionprotected
-
Method Summary
Modifier and TypeMethodDescriptionfinal DateTime
Indicates when the async search will expire.final long
Required - API name:expiration_time_in_millis
final String
id()
API name:id
final boolean
Required - When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.final boolean
Required - Indicates whether the search is still running or has completed.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 <BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>>
voidsetupAsyncSearchResponseBaseDeserializer
(ObjectDeserializer<BuilderT> op) final DateTime
API name:start_time
final long
Required - API name:start_time_in_millis
toString()
-
Constructor Details
-
AsyncSearchResponseBase
-
-
Method Details
-
id
API name:id
-
isPartial
public final boolean isPartial()Required - When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running,is_partial
is always set totrue
.API name:
is_partial
-
isRunning
public final boolean isRunning()Required - Indicates whether the search is still running or has completed. NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even thoughis_running
isfalse
.API name:
is_running
-
expirationTime
Indicates when the async search will expire.API name:
expiration_time
-
expirationTimeInMillis
public final long expirationTimeInMillis()Required - API name:expiration_time_in_millis
-
startTime
API name:start_time
-
startTimeInMillis
public final long startTimeInMillis()Required - API name:start_time_in_millis
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupAsyncSearchResponseBaseDeserializer
protected static <BuilderT extends AsyncSearchResponseBase.AbstractBuilder<BuilderT>> void setupAsyncSearchResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)
-