GetLifecycleRequest (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.GetLifecycleRequest

public class GetLifecycleRequest
extends RequestBase

Retrieves a lifecycle policy.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetLifecycleRequest.Builder
Builder for GetLifecycleRequest.

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

Fields

Modifier and Type Field Description

static Endpoint<GetLifecycleRequest,GetLifecycleResponse,ErrorResponse> _ENDPOINT
Endpoint "ilm.get_lifecycle".

Method Summary

Modifier and Type	Method	Description
`Time`	`masterTimeout()`	Period to wait for a connection to the master node.
`java.lang.String`	`name()`	Identifier for the policy.
`static GetLifecycleRequest`	`of(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)`
`Time`	`timeout()`	Period to wait for a response.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _ENDPOINT
  
  public static final Endpoint<GetLifecycleRequest,GetLifecycleResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "ilm.get_lifecycle".
Method Details
- of
  
  public static GetLifecycleRequest of(java.util.function.Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
- masterTimeout
  
  @Nullable public final Time masterTimeout()
  
  Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
  API name: master_timeout
- name
  
  @Nullable public final java.lang.String name()
  
  Identifier for the policy.
  API name: policy
- timeout
  
  @Nullable public final Time timeout()
  
  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
  API name: timeout