Package co.elastic.clients.elasticsearch.indices

Class RefreshRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.RefreshRequest.Builder

All Implemented Interfaces:

WithJson<RefreshRequest.Builder>, ObjectBuilder<RefreshRequest>

Enclosing class:

RefreshRequest

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

Builder for RefreshRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RefreshRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
RefreshRequest	build()	Builds a RefreshRequest.
final RefreshRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final RefreshRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final RefreshRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final RefreshRequest.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 RefreshRequest.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 RefreshRequest.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

allowNoIndices

public final RefreshRequest.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 RefreshRequest.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 RefreshRequest.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 RefreshRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

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

API name: ignore_unavailable

index

public final RefreshRequest.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 RefreshRequest.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.

self

protected RefreshRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RefreshRequest.Builder>

build

public RefreshRequest build()

Builds a RefreshRequest.

Specified by:

build in interface ObjectBuilder<RefreshRequest>

Throws:

NullPointerException - if some of the required fields are null.