Package co.elastic.clients.elasticsearch.indices

Class ShrinkRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.ShrinkRequest.Builder

All Implemented Interfaces:

WithJson<ShrinkRequest.Builder>, ObjectBuilder<ShrinkRequest>

Enclosing class:

ShrinkRequest

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

Builder for ShrinkRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ShrinkRequest.Builder	aliases(String key, Alias value)	The key is the alias name.
final ShrinkRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	The key is the alias name.
final ShrinkRequest.Builder	aliases(Map<String,Alias> map)	The key is the alias name.
ShrinkRequest	build()	Builds a ShrinkRequest.
final ShrinkRequest.Builder	index(String value)	Required - Name of the source index to shrink.
final ShrinkRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final ShrinkRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
protected ShrinkRequest.Builder	self()
final ShrinkRequest.Builder	settings(String key, JsonData value)	Configuration options for the target index.
final ShrinkRequest.Builder	settings(Map<String,JsonData> map)	Configuration options for the target index.
final ShrinkRequest.Builder	target(String value)	Required - Name of the target index to create.
final ShrinkRequest.Builder	timeout(Time value)	Period to wait for a response.
final ShrinkRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final ShrinkRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
final ShrinkRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.

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

aliases

public final ShrinkRequest.Builder aliases(Map<String,Alias> map)

The key is the alias name. Index alias names support date math.

API name: aliases

Adds all entries of map to aliases.

aliases

public final ShrinkRequest.Builder aliases(String key,
 Alias value)

The key is the alias name. Index alias names support date math.

API name: aliases

Adds an entry to aliases.

aliases

public final ShrinkRequest.Builder aliases(String key,
 Function<Alias.Builder,ObjectBuilder<Alias>> fn)

The key is the alias name. Index alias names support date math.

API name: aliases

Adds an entry to aliases using a builder lambda.

index

public final ShrinkRequest.Builder index(String value)

Required - Name of the source index to shrink.

API name: index

masterTimeout

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

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.

API name: master_timeout

masterTimeout

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

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.

API name: master_timeout

settings

public final ShrinkRequest.Builder settings(Map<String,JsonData> map)

Configuration options for the target index.

API name: settings

Adds all entries of map to settings.

settings

public final ShrinkRequest.Builder settings(String key,
 JsonData value)

Configuration options for the target index.

API name: settings

Adds an entry to settings.

target

public final ShrinkRequest.Builder target(String value)

Required - Name of the target index to create.

API name: target

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

waitForActiveShards

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

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

API name: wait_for_active_shards

waitForActiveShards

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

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

API name: wait_for_active_shards

self

protected ShrinkRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ShrinkRequest.Builder>

build

public ShrinkRequest build()

Builds a ShrinkRequest.

Specified by:

build in interface ObjectBuilder<ShrinkRequest>

Throws:

NullPointerException - if some of the required fields are null.