Package co.elastic.clients.elasticsearch.indices

Class FreezeRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.FreezeRequest.Builder

All Implemented Interfaces:

WithJson<FreezeRequest.Builder>, ObjectBuilder<FreezeRequest>

Enclosing class:

FreezeRequest

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

Builder for FreezeRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final FreezeRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
FreezeRequest	build()	Builds a FreezeRequest.
final FreezeRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final FreezeRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final FreezeRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final FreezeRequest.Builder	index(String value)	Required - The name of the index to freeze
final FreezeRequest.Builder	masterTimeout(Time value)	Specify timeout for connection to master
final FreezeRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to master
protected FreezeRequest.Builder	self()
final FreezeRequest.Builder	timeout(Time value)	Explicit operation timeout
final FreezeRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
final FreezeRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of active shards to wait for before the operation returns.
final FreezeRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Sets the number of active shards to wait for before the operation returns.

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

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

API name: ignore_unavailable

index

public final FreezeRequest.Builder index(String value)

Required - The name of the index to freeze

API name: index

masterTimeout

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

Specify timeout for connection to master

API name: master_timeout

masterTimeout

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

Specify timeout for connection to master

API name: master_timeout

timeout

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

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

waitForActiveShards

public final FreezeRequest.Builder waitForActiveShards(@Nullable
 WaitForActiveShards value)

Sets the number of active shards to wait for before the operation returns.

API name: wait_for_active_shards

waitForActiveShards

public final FreezeRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

Sets the number of active shards to wait for before the operation returns.

API name: wait_for_active_shards

self

protected FreezeRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<FreezeRequest.Builder>

build

public FreezeRequest build()

Builds a FreezeRequest.

Specified by:

build in interface ObjectBuilder<FreezeRequest>

Throws:

NullPointerException - if some of the required fields are null.