Package co.elastic.clients.elasticsearch.slm

Class GetLifecycleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.slm.GetLifecycleRequest

public class GetLifecycleRequest
extends RequestBase

Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

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 final Endpoint<GetLifecycleRequest,GetLifecycleResponse,ErrorResponse>	_ENDPOINT	Endpoint "slm.get_lifecycle".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	The period to wait for a connection to the master node.
static GetLifecycleRequest	of(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)
final List<String>	policyId()	Comma-separated list of snapshot lifecycle policies to retrieve
final Time	timeout()	The 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 "slm.get_lifecycle".

Method Details

of

public static GetLifecycleRequest of(Function<GetLifecycleRequest.Builder,ObjectBuilder<GetLifecycleRequest>> fn)

masterTimeout

@Nullable
public final Time masterTimeout()

The 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

policyId

public final List<String> policyId()

Comma-separated list of snapshot lifecycle policies to retrieve

API name: policy_id

timeout

@Nullable
public final Time timeout()

The 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