Package co.elastic.clients.elasticsearch.sql

Class GetAsyncStatusResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<GetAsyncStatusResponse.Builder>

co.elastic.clients.elasticsearch.sql.GetAsyncStatusResponse.Builder

All Implemented Interfaces:

WithJson<GetAsyncStatusResponse.Builder>, ObjectBuilder<GetAsyncStatusResponse>

Enclosing class:

GetAsyncStatusResponse

public static class GetAsyncStatusResponse.Builder
extends WithJsonObjectBuilderBase<GetAsyncStatusResponse.Builder>
implements ObjectBuilder<GetAsyncStatusResponse>

Builder for GetAsyncStatusResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetAsyncStatusResponse	build()	Builds a GetAsyncStatusResponse.
final GetAsyncStatusResponse.Builder	completionStatus(Number value)	The HTTP status code for the search.
final GetAsyncStatusResponse.Builder	expirationTimeInMillis(long value)	Required - The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.
final GetAsyncStatusResponse.Builder	id(String value)	Required - The identifier for the search.
final GetAsyncStatusResponse.Builder	isPartial(boolean value)	Required - If true, the response does not contain complete search results.
final GetAsyncStatusResponse.Builder	isRunning(boolean value)	Required - If true, the search is still running.
protected GetAsyncStatusResponse.Builder	self()
final GetAsyncStatusResponse.Builder	startTimeInMillis(long value)	Required - The timestamp, in milliseconds since the Unix epoch, when the search started.

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

expirationTimeInMillis

public final GetAsyncStatusResponse.Builder expirationTimeInMillis(long value)

Required - The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.

API name: expiration_time_in_millis

id

public final GetAsyncStatusResponse.Builder id(String value)

Required - The identifier for the search.

API name: id

isRunning

public final GetAsyncStatusResponse.Builder isRunning(boolean value)

Required - If true, the search is still running. If false, the search has finished.

API name: is_running

isPartial

public final GetAsyncStatusResponse.Builder isPartial(boolean value)

Required - If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout.

API name: is_partial

startTimeInMillis

public final GetAsyncStatusResponse.Builder startTimeInMillis(long value)

Required - The timestamp, in milliseconds since the Unix epoch, when the search started. The API returns this property only for running searches.

API name: start_time_in_millis

completionStatus

public final GetAsyncStatusResponse.Builder completionStatus(@Nullable
 Number value)

The HTTP status code for the search. The API returns this property only for completed searches.

API name: completion_status

self

protected GetAsyncStatusResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GetAsyncStatusResponse.Builder>

build

public GetAsyncStatusResponse build()

Builds a GetAsyncStatusResponse.

Specified by:

build in interface ObjectBuilder<GetAsyncStatusResponse>

Throws:

NullPointerException - if some of the required fields are null.