Package co.elastic.clients.elasticsearch.eql

Class GetRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.eql.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 - Identifier for the search.
    GetRequest.Builder keepAlive​(java.lang.String value)
    Period for which the search and its results are stored on the cluster.
    GetRequest.Builder waitForCompletionTimeout​(java.lang.String value)
    Timeout duration to wait for the request to finish.

    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 - Identifier for the search.

      API name: id

    • keepAlive

      public GetRequest.Builder keepAlive​(@Nullable java.lang.String value)
      Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.

      API name: keep_alive

    • waitForCompletionTimeout

      public GetRequest.Builder waitForCompletionTimeout​(@Nullable java.lang.String value)
      Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.

      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.