Package co.elastic.clients.elasticsearch.async_search

Class GetRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.async_search.GetRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetRequest>
Enclosing class:
GetRequest
public static class GetRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetRequest>
Builder for GetRequest.

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    GetRequest build()
    Builds a GetRequest.
    GetRequest.Builder id​(java.lang.String value)
    Required - The async search ID
    GetRequest.Builder keepAlive​(java.lang.String value)
    Specify the time interval in which the results (partial or final) for this search will be available
    GetRequest.Builder typedKeys​(java.lang.Boolean value)
    Specify whether aggregation and suggester names should be prefixed by their respective types in the response
    GetRequest.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 GetRequest.Builder id​(java.lang.String value)
      Required - The async search ID

      API name: id

    • keepAlive

      public GetRequest.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 GetRequest.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 GetRequest.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 GetRequest build()
      Builds a GetRequest.
      Specified by:
      build in interface ObjectBuilder<GetRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.