Class GetAsyncResponse.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<GetAsyncResponse.Builder>
co.elastic.clients.elasticsearch.sql.GetAsyncResponse.Builder
- All Implemented Interfaces:
WithJson<GetAsyncResponse.Builder>
,ObjectBuilder<GetAsyncResponse>
- Enclosing class:
- GetAsyncResponse
public static class GetAsyncResponse.Builder extends WithJsonObjectBuilderBase<GetAsyncResponse.Builder> implements ObjectBuilder<GetAsyncResponse>
Builder for
GetAsyncResponse
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetAsyncResponse
build()
Builds aGetAsyncResponse
.GetAsyncResponse.Builder
columns(Column value, Column... values)
Column headings for the search results.GetAsyncResponse.Builder
columns(java.util.function.Function<Column.Builder,ObjectBuilder<Column>> fn)
Column headings for the search results.GetAsyncResponse.Builder
columns(java.util.List<Column> list)
Column headings for the search results.GetAsyncResponse.Builder
cursor(java.lang.String value)
Cursor for the next set of paginated results.GetAsyncResponse.Builder
id(java.lang.String value)
Required - Identifier for the search.GetAsyncResponse.Builder
isPartial(boolean value)
Required - Iftrue
, the response does not contain complete search results.GetAsyncResponse.Builder
isRunning(boolean value)
Required - Iftrue
, the search is still running.GetAsyncResponse.Builder
rows(java.util.List<JsonData> value, java.util.List<JsonData>... values)
Required - Values for the search results.GetAsyncResponse.Builder
rows(java.util.List<java.util.List<JsonData>> list)
Required - Values for the search results.protected GetAsyncResponse.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
id
Required - Identifier for the search. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in theAsync-ID
HTTP header.API name:
id
-
isRunning
Required - Iftrue
, the search is still running. If false, the search has finished. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in theAsync-partial
HTTP header.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. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in theAsync-partial
HTTP header.API name:
is_partial
-
columns
Column headings for the search results. Each object is a column.API name:
columns
Adds all elements of
list
tocolumns
. -
columns
Column headings for the search results. Each object is a column.API name:
columns
Adds one or more values to
columns
. -
columns
public final GetAsyncResponse.Builder columns(java.util.function.Function<Column.Builder,ObjectBuilder<Column>> fn)Column headings for the search results. Each object is a column.API name:
columns
Adds a value to
columns
using a builder lambda. -
cursor
Cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in theCursor
HTTP header.API name:
cursor
-
rows
Required - Values for the search results.API name:
rows
Adds all elements of
list
torows
. -
rows
public final GetAsyncResponse.Builder rows(java.util.List<JsonData> value, java.util.List<JsonData>... values)Required - Values for the search results.API name:
rows
Adds one or more values to
rows
. -
self
- Specified by:
self
in classWithJsonObjectBuilderBase<GetAsyncResponse.Builder>
-
build
Builds aGetAsyncResponse
.- Specified by:
build
in interfaceObjectBuilder<GetAsyncResponse>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-