Package co.elastic.clients.elasticsearch.indices

Class FlushRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.FlushRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class FlushRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlushRequest.Builder	Builder for FlushRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<FlushRequest,FlushResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.flush".

Constructor Summary

Constructors

Constructor	Description
FlushRequest(FlushRequest.Builder builder)
FlushRequest(java.util.function.Function<FlushRequest.Builder,FlushRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.util.List<ExpandWildcardOptions>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	force()	Whether a flush should be forced even if it is not necessarily needed ie.
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string for all indices
java.lang.Boolean	waitIfOngoing()	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 java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<FlushRequest,FlushResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.flush".

Constructor Details

FlushRequest

public FlushRequest(FlushRequest.Builder builder)

FlushRequest

public FlushRequest(java.util.function.Function<FlushRequest.Builder,FlushRequest.Builder> fn)

Method Details

index

@Nullable
public java.util.List<java.lang.String> index()

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

API name: index

allowNoIndices

@Nullable
public java.lang.Boolean allowNoIndices()

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

@Nullable
public java.util.List<ExpandWildcardOptions> expandWildcards()

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

API name: expand_wildcards

force

@Nullable
public java.lang.Boolean force()

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

@Nullable
public java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

waitIfOngoing

@Nullable
public java.lang.Boolean waitIfOngoing()

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