Package co.elastic.clients.elasticsearch._core

Class FieldCapsRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch._core.FieldCapsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<FieldCapsRequest>

Enclosing class:

FieldCapsRequest

public static class FieldCapsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<FieldCapsRequest>

Builder for FieldCapsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldCapsRequest.Builder	addExpandWildcards(ExpandWildcardOptions value)	Add a value to expandWildcards(List), creating the list if needed.
FieldCapsRequest.Builder	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
FieldCapsRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
FieldCapsRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
FieldCapsRequest	build()	Builds a FieldCapsRequest.
FieldCapsRequest.Builder	expandWildcards(ExpandWildcardOptions... value)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
FieldCapsRequest.Builder	expandWildcards(java.util.List<ExpandWildcardOptions> value)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
FieldCapsRequest.Builder	fields(java.lang.String... value)	A comma-separated list of field names
FieldCapsRequest.Builder	fields(java.util.List<java.lang.String> value)	A comma-separated list of field names
FieldCapsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
FieldCapsRequest.Builder	includeUnmapped(java.lang.Boolean value)	Indicates whether unmapped fields should be included in the response.
FieldCapsRequest.Builder	index(java.lang.String... value)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
FieldCapsRequest.Builder	index(java.util.List<java.lang.String> value)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
FieldCapsRequest.Builder	indexFilter(Query value)	API name: index_filter
FieldCapsRequest.Builder	indexFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: index_filter
FieldCapsRequest.Builder	putRuntimeMappings(java.lang.String key, RuntimeField value)	Add a key/value to runtimeMappings(Map), creating the map if needed.
FieldCapsRequest.Builder	putRuntimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)	Add a key/value to runtimeMappings(Map), creating the map if needed.
FieldCapsRequest.Builder	runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)	Set runtimeMappings(Map) to a singleton map.
FieldCapsRequest.Builder	runtimeMappings(java.util.Map<java.lang.String,RuntimeField> value)	API name: runtime_mappings

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

index

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

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

index

public FieldCapsRequest.Builder index(java.lang.String... value)

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

addIndex

public FieldCapsRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

allowNoIndices

public FieldCapsRequest.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 FieldCapsRequest.Builder expandWildcards(@Nullable
java.util.List<ExpandWildcardOptions> value)

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

API name: expand_wildcards

expandWildcards

public FieldCapsRequest.Builder expandWildcards(ExpandWildcardOptions... value)

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

API name: expand_wildcards

addExpandWildcards

public FieldCapsRequest.Builder addExpandWildcards(ExpandWildcardOptions value)

Add a value to expandWildcards(List), creating the list if needed.

fields

public FieldCapsRequest.Builder fields(@Nullable
java.util.List<java.lang.String> value)

A comma-separated list of field names

API name: fields

fields

public FieldCapsRequest.Builder fields(java.lang.String... value)

A comma-separated list of field names

API name: fields

addFields

public FieldCapsRequest.Builder addFields(java.lang.String value)

Add a value to fields(List), creating the list if needed.

ignoreUnavailable

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

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

API name: ignore_unavailable

includeUnmapped

public FieldCapsRequest.Builder includeUnmapped(@Nullable
java.lang.Boolean value)

Indicates whether unmapped fields should be included in the response.

API name: include_unmapped

indexFilter

public FieldCapsRequest.Builder indexFilter(@Nullable
Query value)

API name: index_filter

indexFilter

public FieldCapsRequest.Builder indexFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: index_filter

runtimeMappings

public FieldCapsRequest.Builder runtimeMappings(@Nullable
java.util.Map<java.lang.String,RuntimeField> value)

API name: runtime_mappings

putRuntimeMappings

public FieldCapsRequest.Builder putRuntimeMappings(java.lang.String key,
RuntimeField value)

Add a key/value to runtimeMappings(Map), creating the map if needed.

runtimeMappings

public FieldCapsRequest.Builder runtimeMappings(java.lang.String key,
java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)

Set runtimeMappings(Map) to a singleton map.

putRuntimeMappings

public FieldCapsRequest.Builder putRuntimeMappings(java.lang.String key,
java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)

Add a key/value to runtimeMappings(Map), creating the map if needed.

build

public FieldCapsRequest build()

Builds a FieldCapsRequest.

Specified by:

build in interface ObjectBuilder<FieldCapsRequest>

Throws:

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