Package co.elastic.clients.elasticsearch.indices

Class ExplainDataLifecycleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.ExplainDataLifecycleRequest.Builder

All Implemented Interfaces:

WithJson<ExplainDataLifecycleRequest.Builder>, ObjectBuilder<ExplainDataLifecycleRequest>

Enclosing class:

ExplainDataLifecycleRequest

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

Builder for ExplainDataLifecycleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainDataLifecycleRequest	build()	Builds a ExplainDataLifecycleRequest.
final ExplainDataLifecycleRequest.Builder	includeDefaults(Boolean value)	Indicates if the API should return the default values the system uses for the index's lifecycle
final ExplainDataLifecycleRequest.Builder	index(String value, String... values)	Required - Comma-separated list of index names to explain
final ExplainDataLifecycleRequest.Builder	index(List<String> list)	Required - Comma-separated list of index names to explain
final ExplainDataLifecycleRequest.Builder	masterTimeout(Time value)	The period to wait for a connection to the master node.
final ExplainDataLifecycleRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a connection to the master node.
protected ExplainDataLifecycleRequest.Builder	self()

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

includeDefaults

public final ExplainDataLifecycleRequest.Builder includeDefaults(@Nullable
 Boolean value)

Indicates if the API should return the default values the system uses for the index's lifecycle

API name: include_defaults

index

public final ExplainDataLifecycleRequest.Builder index(List<String> list)

Required - Comma-separated list of index names to explain

API name: index

Adds all elements of list to index.

index

public final ExplainDataLifecycleRequest.Builder index(String value,
 String... values)

Required - Comma-separated list of index names to explain

API name: index

Adds one or more values to index.

masterTimeout

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

The period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

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

The period to wait for a connection to the master node.

API name: master_timeout

self

protected ExplainDataLifecycleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExplainDataLifecycleRequest.Builder>

build

public ExplainDataLifecycleRequest build()

Builds a ExplainDataLifecycleRequest.

Specified by:

build in interface ObjectBuilder<ExplainDataLifecycleRequest>

Throws:

NullPointerException - if some of the required fields are null.