Package org.opensearch.client.opensearch.indices

Class ShrinkRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ShrinkRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<ShrinkRequest.Builder,ShrinkRequest>, MutableBuilder<ShrinkRequest.Builder,ShrinkRequest>, ObjectBuilder<ShrinkRequest>

Enclosing class:

ShrinkRequest

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

Builder for ShrinkRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ShrinkRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	The key is the alias name.
final ShrinkRequest.Builder	aliases(String key, Alias value)	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	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final ShrinkRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
ShrinkRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShrinkRequest.Builder	copySettings(Boolean value)	whether or not to copy settings from the source index.
final ShrinkRequest.Builder	index(String value)	Required - Name of the source index to shrink.
final ShrinkRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final ShrinkRequest.Builder	masterTimeout(Time value)	Deprecated.
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	taskExecutionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
final ShrinkRequest.Builder	taskExecutionTimeout(Time value)	Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
final ShrinkRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final ShrinkRequest.Builder	timeout(Time value)	Period to wait for a response.
final ShrinkRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final ShrinkRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
final ShrinkRequest.Builder	waitForCompletion(Boolean value)	Should this request wait until the operation has completed before returning.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ShrinkRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ShrinkRequest.Builder,ShrinkRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ShrinkRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ShrinkRequest.Builder>

aliases

@Nonnull
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 elements of map to aliases.

aliases

@Nonnull
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

@Nonnull
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 a value to aliases using a builder lambda.

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final ShrinkRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

copySettings

@Nonnull
public final ShrinkRequest.Builder copySettings(@Nullable
 Boolean value)

whether or not to copy settings from the source index.

API name: copy_settings

index

@Nonnull
public final ShrinkRequest.Builder index(String value)

Required - Name of the source index to shrink.

API name: index

masterTimeout

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

Deprecated.

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

API name: master_timeout

masterTimeout

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

Deprecated.

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

API name: master_timeout

settings

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

Configuration options for the target index.

API name: settings

Adds all elements of map to settings.

settings

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

Configuration options for the target index.

API name: settings

Adds an entry to settings.

target

@Nonnull
public final ShrinkRequest.Builder target(String value)

Required - Name of the target index to create.

API name: target

taskExecutionTimeout

@Nonnull
public final ShrinkRequest.Builder taskExecutionTimeout(@Nullable
 Time value)

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

API name: task_execution_timeout

taskExecutionTimeout

@Nonnull
public final ShrinkRequest.Builder taskExecutionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

API name: task_execution_timeout

timeout

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

waitForCompletion

@Nonnull
public final ShrinkRequest.Builder waitForCompletion(@Nullable
 Boolean value)

Should this request wait until the operation has completed before returning.

API name: wait_for_completion

build

@Nonnull
public ShrinkRequest build()

Builds a ShrinkRequest.

Specified by:

build in interface ObjectBuilder<ShrinkRequest>

Throws:

NullPointerException - if some of the required fields are null.