Class FieldCapability.Builder
- All Implemented Interfaces:
WithJson<FieldCapability.Builder>
,ObjectBuilder<FieldCapability>
- Enclosing class:
- FieldCapability
FieldCapability
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal FieldCapability.Builder
aggregatable
(boolean value) Required - Whether this field can be aggregated on all indices.build()
Builds aFieldCapability
.final FieldCapability.Builder
The list of indices where this field has the same type family, or null if all indices have the same type family for the field.final FieldCapability.Builder
The list of indices where this field has the same type family, or null if all indices have the same type family for the field.final FieldCapability.Builder
Merged metadata across all indices as a map of string keys to arrays of values.final FieldCapability.Builder
Merged metadata across all indices as a map of string keys to arrays of values.final FieldCapability.Builder
metadataField
(Boolean value) Whether this field is registered as a metadata field.final FieldCapability.Builder
metricConflictsIndices
(String value, String... values) The list of indices where this field is present if these indices don’t have the sametime_series_metric
value for this field.final FieldCapability.Builder
metricConflictsIndices
(List<String> list) The list of indices where this field is present if these indices don’t have the sametime_series_metric
value for this field.final FieldCapability.Builder
nonAggregatableIndices
(String value, String... values) The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.final FieldCapability.Builder
nonAggregatableIndices
(List<String> list) The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.final FieldCapability.Builder
nonDimensionIndices
(String value, String... values) If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not.final FieldCapability.Builder
nonDimensionIndices
(List<String> list) If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not.final FieldCapability.Builder
nonSearchableIndices
(String value, String... values) The list of indices where this field is not searchable, or null if all indices have the same definition for the field.final FieldCapability.Builder
nonSearchableIndices
(List<String> list) The list of indices where this field is not searchable, or null if all indices have the same definition for the field.final FieldCapability.Builder
searchable
(boolean value) Required - Whether this field is indexed for search on all indices.protected FieldCapability.Builder
self()
final FieldCapability.Builder
timeSeriesDimension
(Boolean value) Whether this field is used as a time series dimension.final FieldCapability.Builder
Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric.final FieldCapability.Builder
Required - API name:type
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
aggregatable
Required - Whether this field can be aggregated on all indices.API name:
aggregatable
-
indices
The list of indices where this field has the same type family, or null if all indices have the same type family for the field.API name:
indices
Adds all elements of
list
toindices
. -
indices
The list of indices where this field has the same type family, or null if all indices have the same type family for the field.API name:
indices
Adds one or more values to
indices
. -
meta
Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.API name:
meta
Adds all entries of
map
tometa
. -
meta
Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key.API name:
meta
Adds an entry to
meta
. -
nonAggregatableIndices
The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.API name:
non_aggregatable_indices
Adds all elements of
list
tononAggregatableIndices
. -
nonAggregatableIndices
The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.API name:
non_aggregatable_indices
Adds one or more values to
nonAggregatableIndices
. -
nonSearchableIndices
The list of indices where this field is not searchable, or null if all indices have the same definition for the field.API name:
non_searchable_indices
Adds all elements of
list
tononSearchableIndices
. -
nonSearchableIndices
The list of indices where this field is not searchable, or null if all indices have the same definition for the field.API name:
non_searchable_indices
Adds one or more values to
nonSearchableIndices
. -
searchable
Required - Whether this field is indexed for search on all indices.API name:
searchable
-
type
Required - API name:type
-
metadataField
Whether this field is registered as a metadata field.API name:
metadata_field
-
timeSeriesDimension
Whether this field is used as a time series dimension.API name:
time_series_dimension
-
timeSeriesMetric
Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric.API name:
time_series_metric
-
nonDimensionIndices
If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not.API name:
non_dimension_indices
Adds all elements of
list
tononDimensionIndices
. -
nonDimensionIndices
If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not.API name:
non_dimension_indices
Adds one or more values to
nonDimensionIndices
. -
metricConflictsIndices
The list of indices where this field is present if these indices don’t have the sametime_series_metric
value for this field.API name:
metric_conflicts_indices
Adds all elements of
list
tometricConflictsIndices
. -
metricConflictsIndices
The list of indices where this field is present if these indices don’t have the sametime_series_metric
value for this field.API name:
metric_conflicts_indices
Adds one or more values to
metricConflictsIndices
. -
self
- Specified by:
self
in classWithJsonObjectBuilderBase<FieldCapability.Builder>
-
build
Builds aFieldCapability
.- Specified by:
build
in interfaceObjectBuilder<FieldCapability>
- Throws:
NullPointerException
- if some of the required fields are null.
-