Package co.elastic.clients.elasticsearch.eql

Class GetStatusResponse.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public GetStatusResponse.Builder id​(java.lang.String value)
      Required - Identifier for the search.

      API name: id

    • isPartial

      public GetStatusResponse.Builder isPartial​(boolean value)
      Required - If true, the search request is still executing. If false, the search is completed.

      API name: is_partial

    • isRunning

      public GetStatusResponse.Builder isRunning​(boolean value)
      Required - If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts.

      API name: is_running

    • startTimeInMillis

      public GetStatusResponse.Builder startTimeInMillis​(@Nullable java.lang.String value)
      For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch.

      API name: start_time_in_millis

    • expirationTimeInMillis

      public GetStatusResponse.Builder expirationTimeInMillis​(@Nullable java.lang.String value)
      Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing.

      API name: expiration_time_in_millis

    • completionStatus

      public GetStatusResponse.Builder completionStatus​(@Nullable java.lang.Integer value)
      For a completed search shows the http status code of the completed search.

      API name: completion_status

    • build

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