Package org.opensearch.client.opensearch.indices

Class ShrinkRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.ShrinkRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ShrinkRequest>

Enclosing class:

ShrinkRequest

public static class ShrinkRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ShrinkRequest>

Builder for ShrinkRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShrinkRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	API name: aliases
ShrinkRequest.Builder	aliases(java.lang.String key, Alias value)	API name: aliases
ShrinkRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> map)	API name: aliases
ShrinkRequest	build()	Builds a ShrinkRequest.
ShrinkRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
ShrinkRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
ShrinkRequest.Builder	index(java.lang.String value)	Required - The name of the source index to shrink
ShrinkRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
ShrinkRequest.Builder	masterTimeout(Time value)	Deprecated.
ShrinkRequest.Builder	settings(java.lang.String key, JsonData value)	API name: settings
ShrinkRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> map)	API name: settings
ShrinkRequest.Builder	target(java.lang.String value)	Required - The name of the target index to shrink into
ShrinkRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
ShrinkRequest.Builder	timeout(Time value)	Explicit operation timeout
ShrinkRequest.Builder	waitForActiveShards(java.util.function.Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Set the number of active shards to wait for on the shrunken index before the operation returns.
ShrinkRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Set the number of active shards to wait for on the shrunken index before the operation returns.

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

aliases

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

API name: aliases

Adds all entries of map to aliases.

aliases

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

API name: aliases

Adds an entry to aliases.

aliases

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

API name: aliases

Adds an entry to aliases using a builder lambda.

index

public final ShrinkRequest.Builder index(java.lang.String value)

Required - The name of the source index to shrink

API name: index

masterTimeout

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

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final ShrinkRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

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

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final ShrinkRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

settings

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

API name: settings

Adds all entries of map to settings.

settings

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

API name: settings

Adds an entry to settings.

target

public final ShrinkRequest.Builder target(java.lang.String value)

Required - The name of the target index to shrink into

API name: target

timeout

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

Explicit operation timeout

API name: timeout

timeout

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

Explicit operation timeout

API name: timeout

waitForActiveShards

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

Set the number of active shards to wait for on the shrunken index before the operation returns.

API name: wait_for_active_shards

waitForActiveShards

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

Set the number of active shards to wait for on the shrunken index before the operation returns.

API name: wait_for_active_shards

build

public ShrinkRequest build()

Builds a ShrinkRequest.

Specified by:

build in interface ObjectBuilder<ShrinkRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.