Package co.elastic.clients.elasticsearch.esql

Class AsyncQueryStopRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<AsyncQueryStopRequest.Builder>

co.elastic.clients.elasticsearch.esql.AsyncQueryStopRequest.Builder

All Implemented Interfaces:

WithJson<AsyncQueryStopRequest.Builder>, ObjectBuilder<AsyncQueryStopRequest>

Enclosing class:

AsyncQueryStopRequest

public static class AsyncQueryStopRequest.Builder
extends RequestBase.AbstractBuilder<AsyncQueryStopRequest.Builder>
implements ObjectBuilder<AsyncQueryStopRequest>

Builder for AsyncQueryStopRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AsyncQueryStopRequest	build()	Builds a AsyncQueryStopRequest.
final AsyncQueryStopRequest.Builder	dropNullColumns(Boolean value)	Indicates whether columns that are entirely null will be removed from the columns and values portion of the results.
final AsyncQueryStopRequest.Builder	id(String value)	Required - The unique identifier of the query.
protected AsyncQueryStopRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dropNullColumns

public final AsyncQueryStopRequest.Builder dropNullColumns(@Nullable
 Boolean value)

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 AsyncQueryStopRequest.Builder id(String value)

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

self

protected AsyncQueryStopRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AsyncQueryStopRequest.Builder>

build

public AsyncQueryStopRequest build()

Builds a AsyncQueryStopRequest.

Specified by:

build in interface ObjectBuilder<AsyncQueryStopRequest>

Throws:

NullPointerException - if some of the required fields are null.