Package co.elastic.clients.elasticsearch.slm

Class PutLifecycleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutLifecycleRequest.Builder>

co.elastic.clients.elasticsearch.slm.PutLifecycleRequest.Builder

All Implemented Interfaces:

WithJson<PutLifecycleRequest.Builder>, ObjectBuilder<PutLifecycleRequest>

Enclosing class:

PutLifecycleRequest

public static class PutLifecycleRequest.Builder
extends RequestBase.AbstractBuilder<PutLifecycleRequest.Builder>
implements ObjectBuilder<PutLifecycleRequest>

Builder for PutLifecycleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutLifecycleRequest	build()	Builds a PutLifecycleRequest.
final PutLifecycleRequest.Builder	config(SlmConfiguration value)	Configuration for each snapshot created by the policy.
final PutLifecycleRequest.Builder	config(Function<SlmConfiguration.Builder,ObjectBuilder<SlmConfiguration>> fn)	Configuration for each snapshot created by the policy.
final PutLifecycleRequest.Builder	masterTimeout(Time value)	The period to wait for a connection to the master node.
final PutLifecycleRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a connection to the master node.
final PutLifecycleRequest.Builder	name(String value)	Name automatically assigned to each snapshot created by the policy.
final PutLifecycleRequest.Builder	policyId(String value)	Required - The identifier for the snapshot lifecycle policy you want to create or update.
final PutLifecycleRequest.Builder	repository(String value)	Repository used to store snapshots created by this policy.
final PutLifecycleRequest.Builder	retention(Retention value)	Retention rules used to retain and delete snapshots created by the policy.
final PutLifecycleRequest.Builder	retention(Function<Retention.Builder,ObjectBuilder<Retention>> fn)	Retention rules used to retain and delete snapshots created by the policy.
final PutLifecycleRequest.Builder	schedule(String value)	Periodic or absolute schedule at which the policy creates snapshots.
protected PutLifecycleRequest.Builder	self()
final PutLifecycleRequest.Builder	timeout(Time value)	The period to wait for a response.
final PutLifecycleRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a response.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

config

public final PutLifecycleRequest.Builder config(@Nullable
 SlmConfiguration value)

Configuration for each snapshot created by the policy.

API name: config

config

public final PutLifecycleRequest.Builder config(Function<SlmConfiguration.Builder,ObjectBuilder<SlmConfiguration>> fn)

Configuration for each snapshot created by the policy.

API name: config

masterTimeout

public final PutLifecycleRequest.Builder masterTimeout(@Nullable
 Time value)

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. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

masterTimeout

public final PutLifecycleRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

name

public final PutLifecycleRequest.Builder name(@Nullable
 String value)

Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.

API name: name

policyId

public final PutLifecycleRequest.Builder policyId(String value)

Required - The identifier for the snapshot lifecycle policy you want to create or update.

API name: policy_id

repository

public final PutLifecycleRequest.Builder repository(@Nullable
 String value)

Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.

API name: repository

retention

public final PutLifecycleRequest.Builder retention(@Nullable
 Retention value)

Retention rules used to retain and delete snapshots created by the policy.

API name: retention

retention

public final PutLifecycleRequest.Builder retention(Function<Retention.Builder,ObjectBuilder<Retention>> fn)

Retention rules used to retain and delete snapshots created by the policy.

API name: retention

schedule

public final PutLifecycleRequest.Builder schedule(@Nullable
 String value)

Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.

API name: schedule

timeout

public final PutLifecycleRequest.Builder timeout(@Nullable
 Time value)

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: timeout

timeout

public final PutLifecycleRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: timeout

self

protected PutLifecycleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutLifecycleRequest.Builder>

build

public PutLifecycleRequest build()

Builds a PutLifecycleRequest.

Specified by:

build in interface ObjectBuilder<PutLifecycleRequest>

Throws:

NullPointerException - if some of the required fields are null.