Package org.opensearch.client.opensearch.indices

Class ClearCacheRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.ClearCacheRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ClearCacheRequest>

Enclosing class:

ClearCacheRequest

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

Builder for ClearCacheRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClearCacheRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
ClearCacheRequest	build()	Builds a ClearCacheRequest.
ClearCacheRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
ClearCacheRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
ClearCacheRequest.Builder	fielddata(java.lang.Boolean value)	Clear field data
ClearCacheRequest.Builder	fields(java.lang.String value, java.lang.String... values)	A comma-separated list of fields to clear when using the fielddata parameter (default: all)
ClearCacheRequest.Builder	fields(java.util.List<java.lang.String> list)	A comma-separated list of fields to clear when using the fielddata parameter (default: all)
ClearCacheRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
ClearCacheRequest.Builder	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index name to limit the operation
ClearCacheRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index name to limit the operation
ClearCacheRequest.Builder	query(java.lang.Boolean value)	Clear query caches
ClearCacheRequest.Builder	request(java.lang.Boolean value)	Clear request cache

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

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

fielddata

public final ClearCacheRequest.Builder fielddata(@Nullable
                                                 java.lang.Boolean value)

Clear field data

API name: fielddata

fields

public final ClearCacheRequest.Builder fields(java.util.List<java.lang.String> list)

A comma-separated list of fields to clear when using the fielddata parameter (default: all)

API name: fields

Adds all elements of list to fields.

fields

public final ClearCacheRequest.Builder fields(java.lang.String value,
                                              java.lang.String... values)

A comma-separated list of fields to clear when using the fielddata parameter (default: all)

API name: fields

Adds one or more values to fields.

ignoreUnavailable

public final ClearCacheRequest.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 ClearCacheRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index name to limit the operation

API name: index

Adds all elements of list to index.

index

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

A comma-separated list of index name to limit the operation

API name: index

Adds one or more values to index.

query

public final ClearCacheRequest.Builder query(@Nullable
                                             java.lang.Boolean value)

Clear query caches

API name: query

request

public final ClearCacheRequest.Builder request(@Nullable
                                               java.lang.Boolean value)

Clear request cache

API name: request

build

public ClearCacheRequest build()

Builds a ClearCacheRequest.

Specified by:

build in interface ObjectBuilder<ClearCacheRequest>

Throws:

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