GetRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.async_search.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 <TDocument> Endpoint<GetRequest,GetResponse<TDocument>,ElasticsearchError>`	`createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)`	Create an "`async_search.get`" endpoint.
`java.lang.String`	`id()`	Required - The async search ID
`java.lang.String`	`keepAlive()`	Specify the time interval in which the results (partial or final) for this search will be available
`java.lang.Boolean`	`typedKeys()`	Specify whether aggregation and suggester names should be prefixed by their respective types in the response
`java.lang.String`	`waitForCompletionTimeout()`	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
- 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 - The async search ID
  API name: id
- keepAlive
  
  @Nullable public java.lang.String keepAlive()
  
  Specify the time interval in which the results (partial or final) for this search will be available
  API name: keep_alive
- typedKeys
  
  @Nullable public java.lang.Boolean typedKeys()
  
  Specify whether aggregation and suggester names should be prefixed by their respective types in the response
  API name: typed_keys
- waitForCompletionTimeout
  
  @Nullable public java.lang.String waitForCompletionTimeout()
  
  Specify the time that the request should block waiting for the final response
  API name: wait_for_completion_timeout
- createGetEndpoint
  
  public static <TDocument> Endpoint<GetRequest,GetResponse<TDocument>,ElasticsearchError> createGetEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)
  
  Create an "async_search.get" endpoint.