Package org.opensearch.client.opensearch.indices

Class FlushRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.FlushRequest.Builder

All Implemented Interfaces:

ObjectBuilder<FlushRequest>

Enclosing class:

FlushRequest

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

Builder for FlushRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FlushRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
FlushRequest	build()	Builds a FlushRequest.
FlushRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
FlushRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
FlushRequest.Builder	force(java.lang.Boolean value)	Whether a flush should be forced even if it is not necessarily needed ie.
FlushRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
FlushRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names; use _all or empty string for all indices
FlushRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names; use _all or empty string for all indices
FlushRequest.Builder	waitIfOngoing(java.lang.Boolean value)	If set to true the flush operation will block until the flush can be executed if another flush operation is already executing.

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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

allowNoIndices

public final FlushRequest.Builder allowNoIndices(@Nullable
                                                 java.lang.Boolean value)

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final FlushRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final FlushRequest.Builder expandWildcards(ExpandWildcard value,
                                                  ExpandWildcard... values)

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

Adds one or more values to expandWildcards.

force

public final FlushRequest.Builder force(@Nullable
                                        java.lang.Boolean value)

Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)

API name: force

ignoreUnavailable

public final FlushRequest.Builder ignoreUnavailable(@Nullable
                                                    java.lang.Boolean value)

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final FlushRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index names; use _all or empty string for all indices

API name: index

Adds all elements of list to index.

index

public final FlushRequest.Builder index(java.lang.String value,
                                        java.lang.String... values)

A comma-separated list of index names; use _all or empty string for all indices

API name: index

Adds one or more values to index.

waitIfOngoing

public final FlushRequest.Builder waitIfOngoing(@Nullable
                                                java.lang.Boolean value)

If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.

API name: wait_if_ongoing

build

public FlushRequest build()

Builds a FlushRequest.

Specified by:

build in interface ObjectBuilder<FlushRequest>

Throws:

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