Package co.elastic.clients.elasticsearch.indices

Class SegmentsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.SegmentsRequest.Builder

All Implemented Interfaces:

WithJson<SegmentsRequest.Builder>, ObjectBuilder<SegmentsRequest>

Enclosing class:

SegmentsRequest

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

Builder for SegmentsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SegmentsRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
SegmentsRequest	build()	Builds a SegmentsRequest.
final SegmentsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final SegmentsRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final SegmentsRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final SegmentsRequest.Builder	index(String value, String... values)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
final SegmentsRequest.Builder	index(List<String> list)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
protected SegmentsRequest.Builder	self()
final SegmentsRequest.Builder	verbose(Boolean value)	Includes detailed memory usage by Lucene.

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

allowNoIndices

public final SegmentsRequest.Builder allowNoIndices(@Nullable
 Boolean value)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final SegmentsRequest.Builder expandWildcards(List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final SegmentsRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

public final SegmentsRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

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

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

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

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

verbose

public final SegmentsRequest.Builder verbose(@Nullable
 Boolean value)

Includes detailed memory usage by Lucene.

API name: verbose

self

protected SegmentsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SegmentsRequest.Builder>

build

public SegmentsRequest build()

Builds a SegmentsRequest.

Specified by:

build in interface ObjectBuilder<SegmentsRequest>

Throws:

NullPointerException - if some of the required fields are null.