Package org.opensearch.client.opensearch.indices

Class SplitRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.indices.SplitRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SplitRequest

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

Builder for SplitRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SplitRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases for the resulting index.
final SplitRequest.Builder	aliases(String key, Alias value)	Aliases for the resulting index.
final SplitRequest.Builder	aliases(Map<String,Alias> map)	Aliases for the resulting index.
SplitRequest	build()	Builds a SplitRequest.
final SplitRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final SplitRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
SplitRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SplitRequest.Builder	copySettings(Boolean value)	whether or not to copy settings from the source index.
final SplitRequest.Builder	index(String value)	Required - Name of the source index to split.
final SplitRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final SplitRequest.Builder	masterTimeout(Time value)	Deprecated.
protected SplitRequest.Builder	self()
final SplitRequest.Builder	settings(String key, JsonData value)	Configuration options for the target index.
final SplitRequest.Builder	settings(Map<String,JsonData> map)	Configuration options for the target index.
final SplitRequest.Builder	target(String value)	Required - Name of the target index to create.
final SplitRequest.Builder	taskExecutionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
final SplitRequest.Builder	taskExecutionTimeout(Time value)	Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.
final SplitRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final SplitRequest.Builder	timeout(Time value)	Period to wait for a response.
final SplitRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final SplitRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.
final SplitRequest.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 SplitRequest.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<SplitRequest.Builder,SplitRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SplitRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SplitRequest.Builder>

aliases

@Nonnull
public final SplitRequest.Builder aliases(Map<String,Alias> map)

Aliases for the resulting index.

API name: aliases

Adds all elements of map to aliases.

aliases

@Nonnull
public final SplitRequest.Builder aliases(String key,
 Alias value)

Aliases for the resulting index.

API name: aliases

Adds an entry to aliases.

aliases

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

Aliases for the resulting index.

API name: aliases

Adds a value to aliases using a builder lambda.

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final SplitRequest.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 SplitRequest.Builder copySettings(@Nullable
 Boolean value)

whether or not to copy settings from the source index.

API name: copy_settings

index

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

Required - Name of the source index to split.

API name: index

masterTimeout

@Deprecated
@Nonnull
public final SplitRequest.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 SplitRequest.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 SplitRequest.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 SplitRequest.Builder settings(String key,
 JsonData value)

Configuration options for the target index.

API name: settings

Adds an entry to settings.

target

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

Required - Name of the target index to create.

API name: target

taskExecutionTimeout

@Nonnull
public final SplitRequest.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 SplitRequest.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 SplitRequest.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 SplitRequest.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 SplitRequest.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 SplitRequest.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 SplitRequest.Builder waitForCompletion(@Nullable
 Boolean value)

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

API name: wait_for_completion

build

@Nonnull
public SplitRequest build()

Builds a SplitRequest.

Specified by:

build in interface ObjectBuilder<SplitRequest>

Throws:

NullPointerException - if some of the required fields are null.