Package org.opensearch.client.opensearch.indices

Class RolloverRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.indices.RolloverRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

RolloverRequest

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

Builder for RolloverRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RolloverRequest.Builder	alias(String value)	Required - Name of the data stream or index alias to roll over.
final RolloverRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases for the target index.
final RolloverRequest.Builder	aliases(String key, Alias value)	Aliases for the target index.
final RolloverRequest.Builder	aliases(Map<String,Alias> map)	Aliases for the target index.
RolloverRequest	build()	Builds a RolloverRequest.
final RolloverRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final RolloverRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
final RolloverRequest.Builder	conditions(Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)	API name: conditions
final RolloverRequest.Builder	conditions(RolloverConditions value)	API name: conditions
RolloverRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RolloverRequest.Builder	dryRun(Boolean value)	If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.
final RolloverRequest.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
final RolloverRequest.Builder	mappings(TypeMapping value)	API name: mappings
final RolloverRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final RolloverRequest.Builder	masterTimeout(Time value)	Deprecated.
final RolloverRequest.Builder	newIndex(String value)	The name of the index to create.
protected RolloverRequest.Builder	self()
final RolloverRequest.Builder	settings(String key, JsonData value)	Configuration options for the index.
final RolloverRequest.Builder	settings(Map<String,JsonData> map)	Configuration options for the index.
final RolloverRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final RolloverRequest.Builder	timeout(Time value)	Period to wait for a response.
final RolloverRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	The number of shard copies that must be active before proceeding with the operation.
final RolloverRequest.Builder	waitForActiveShards(WaitForActiveShards value)	The number of shard copies that must be active before proceeding with the operation.

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 RolloverRequest.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<RolloverRequest.Builder,RolloverRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RolloverRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RolloverRequest.Builder>

alias

@Nonnull
public final RolloverRequest.Builder alias(String value)

Required - Name of the data stream or index alias to roll over.

API name: alias

aliases

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

Aliases for the target index. Data streams do not support this parameter.

API name: aliases

Adds all elements of map to aliases.

aliases

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

Aliases for the target index. Data streams do not support this parameter.

API name: aliases

Adds an entry to aliases.

aliases

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

Aliases for the target index. Data streams do not support this parameter.

API name: aliases

Adds a value to aliases using a builder lambda.

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

conditions

@Nonnull
public final RolloverRequest.Builder conditions(@Nullable
 RolloverConditions value)

API name: conditions

conditions

@Nonnull
public final RolloverRequest.Builder conditions(Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)

API name: conditions

dryRun

@Nonnull
public final RolloverRequest.Builder dryRun(@Nullable
 Boolean value)

If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.

API name: dry_run

mappings

@Nonnull
public final RolloverRequest.Builder mappings(@Nullable
 TypeMapping value)

API name: mappings

mappings

@Nonnull
public final RolloverRequest.Builder mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

API name: mappings

masterTimeout

@Deprecated
@Nonnull
public final RolloverRequest.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 RolloverRequest.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

newIndex

@Nonnull
public final RolloverRequest.Builder newIndex(@Nullable
 String value)

The name of the index to create. Supports date math. Data streams do not support this parameter.

API name: new_index

settings

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

Configuration options for the index. Data streams do not support this parameter.

API name: settings

Adds all elements of map to settings.

settings

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

Configuration options for the index. Data streams do not support this parameter.

API name: settings

Adds an entry to settings.

timeout

@Nonnull
public final RolloverRequest.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 RolloverRequest.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 RolloverRequest.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 RolloverRequest.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

build

@Nonnull
public RolloverRequest build()

Builds a RolloverRequest.

Specified by:

build in interface ObjectBuilder<RolloverRequest>

Throws:

NullPointerException - if some of the required fields are null.