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 aGetAsyncStatusResponse
.GetAsyncStatusResponse.Builder
completionStatus(java.lang.Number value)
HTTP status code for the search.GetAsyncStatusResponse.Builder
expirationTimeInMillis(java.lang.Number value)
Required - Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.GetAsyncStatusResponse.Builder
id(java.lang.String value)
Required - Identifier for the search.GetAsyncStatusResponse.Builder
isPartial(boolean value)
Required - Iftrue
, the response does not contain complete search results.GetAsyncStatusResponse.Builder
isRunning(boolean value)
Required - Iftrue
, the search is still running.protected GetAsyncStatusResponse.Builder
self()
GetAsyncStatusResponse.Builder
startTimeInMillis(java.lang.Number value)
Required - 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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
Required - Identifier for the search.API name:
id
-
isRunning
Required - Iftrue
, the search is still running. Iffalse
, the search has finished.API name:
is_running
-
isPartial
Required - Iftrue
, the response does not contain complete search results. Ifis_partial
istrue
andis_running
istrue
, the search is still running. Ifis_partial
istrue
butis_running
isfalse
, the results are partial due to a failure or timeout.API name:
is_partial
-
startTimeInMillis
Required - Timestamp, in milliseconds since the Unix epoch, when the search started. The API only returns this property for running searches.API name:
start_time_in_millis
-
expirationTimeInMillis
Required - 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
-
completionStatus
HTTP status code for the search. The API only returns this property for completed searches.API name:
completion_status
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<GetAsyncStatusResponse.Builder>
-
build
Builds aGetAsyncStatusResponse
.- Specified by:
build
in interfaceObjectBuilder<GetAsyncStatusResponse>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-