GetRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.eql.GetRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetRequest.Builder
Builder for GetRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
Constructor Summary

Constructors

Constructor Description

GetRequest(GetRequest.Builder builder)

GetRequest(java.util.function.Function<GetRequest.Builder,GetRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
`static <TEvent> Endpoint<GetRequest,GetResponse<TEvent>,ElasticsearchError>`	`createGetEndpoint(JsonpDeserializer<TEvent> tEventDeserializer)`	Create an "`eql.get`" endpoint.
`java.lang.String`	`id()`	Required - Identifier for the search.
`java.lang.String`	`keepAlive()`	Period for which the search and its results are stored on the cluster.
`java.lang.String`	`waitForCompletionTimeout()`	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
- GetRequest
  
  public GetRequest(GetRequest.Builder builder)
- GetRequest
  
  public GetRequest(java.util.function.Function<GetRequest.Builder,GetRequest.Builder> fn)
Method Details
- id
  
  public java.lang.String id()
  
  Required - Identifier for the search.
  API name: id
- keepAlive
  
  @Nullable public java.lang.String keepAlive()
  
  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
  
  @Nullable public java.lang.String waitForCompletionTimeout()
  
  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
- createGetEndpoint
  
  public static <TEvent> Endpoint<GetRequest,GetResponse<TEvent>,ElasticsearchError> createGetEndpoint(JsonpDeserializer<TEvent> tEventDeserializer)
  
  Create an "eql.get" endpoint.