Package co.elastic.clients.elasticsearch.esql

Class AsyncQueryStopRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.esql.AsyncQueryStopRequest

public class AsyncQueryStopRequest
extends RequestBase

Stop async ES|QL query.

This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AsyncQueryStopRequest.Builder	Builder for AsyncQueryStopRequest.

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 final Endpoint<AsyncQueryStopRequest,BinaryResponse,ErrorResponse>	_ENDPOINT	Endpoint "esql.async_query_stop".

Method Summary

Modifier and Type	Method	Description
final Boolean	dropNullColumns()	Indicates whether columns that are entirely null will be removed from the columns and values portion of the results.
final String	id()	Required - The unique identifier of the query.
static AsyncQueryStopRequest	of(Function<AsyncQueryStopRequest.Builder,ObjectBuilder<AsyncQueryStopRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<AsyncQueryStopRequest,BinaryResponse,ErrorResponse> _ENDPOINT

Endpoint "esql.async_query_stop".

Method Details

of

public static AsyncQueryStopRequest of(Function<AsyncQueryStopRequest.Builder,ObjectBuilder<AsyncQueryStopRequest>> fn)

dropNullColumns

@Nullable
public final Boolean dropNullColumns()

Indicates whether columns that are entirely null will be removed from the columns and values portion of the results. If true, the response will include an extra section under the name all_columns which has the name of all the columns.

API name: drop_null_columns

id

public final String id()

Required - The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the keep_on_completion parameter set to true.

API name: id