Package co.elastic.clients.elasticsearch.async_search

Class GetAsyncSearchRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.async_search.GetAsyncSearchRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetAsyncSearchRequest>

Enclosing class:

GetAsyncSearchRequest

public static class GetAsyncSearchRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetAsyncSearchRequest>

Builder for GetAsyncSearchRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetAsyncSearchRequest	build()	Builds a GetAsyncSearchRequest.
GetAsyncSearchRequest.Builder	id(java.lang.String value)	Required - The async search ID
GetAsyncSearchRequest.Builder	keepAlive(java.lang.String value)	Specify the time interval in which the results (partial or final) for this search will be available
GetAsyncSearchRequest.Builder	typedKeys(java.lang.Boolean value)	Specify whether aggregation and suggester names should be prefixed by their respective types in the response
GetAsyncSearchRequest.Builder	waitForCompletionTimeout(java.lang.String value)	Specify the time that the request should block waiting for the final response

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

public GetAsyncSearchRequest.Builder id(java.lang.String value)

Required - The async search ID

API name: id

keepAlive

public GetAsyncSearchRequest.Builder keepAlive(@Nullable
java.lang.String value)

Specify the time interval in which the results (partial or final) for this search will be available

API name: keep_alive

typedKeys

public GetAsyncSearchRequest.Builder typedKeys(@Nullable
java.lang.Boolean value)

Specify whether aggregation and suggester names should be prefixed by their respective types in the response

API name: typed_keys

waitForCompletionTimeout

public GetAsyncSearchRequest.Builder waitForCompletionTimeout(@Nullable
java.lang.String value)

Specify the time that the request should block waiting for the final response

API name: wait_for_completion_timeout

build

public GetAsyncSearchRequest build()

Builds a GetAsyncSearchRequest.

Specified by:

build in interface ObjectBuilder<GetAsyncSearchRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.