Class FieldCapability.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.field_caps.FieldCapability.Builder
- All Implemented Interfaces:
CopyableBuilder<FieldCapability.Builder,,FieldCapability> MutableBuilder<FieldCapability.Builder,,FieldCapability> ObjectBuilder<FieldCapability>
- Enclosing class:
FieldCapability
public static class FieldCapability.Builder
extends ObjectBuilderBase
implements CopyableBuilder<FieldCapability.Builder,FieldCapability>
Builder for
FieldCapability.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal FieldCapability.Builderaggregatable(boolean value) Required - Whether this field can be aggregated on all indexes.build()Builds aFieldCapability.copy()Create a new builderCopyableBuilderthat is a copy of this one.final FieldCapability.BuilderAPI name:indicesfinal FieldCapability.BuilderAPI name:indicesfinal FieldCapability.BuilderAPI name:metafinal FieldCapability.BuilderAPI name:metafinal FieldCapability.BuildermetadataField(Boolean value) Whether this field is registered as a metadata field.final FieldCapability.BuildernonAggregatableIndices(String value, String... values) API name:non_aggregatable_indicesfinal FieldCapability.BuildernonAggregatableIndices(List<String> list) API name:non_aggregatable_indicesfinal FieldCapability.BuildernonSearchableIndices(String value, String... values) API name:non_searchable_indicesfinal FieldCapability.BuildernonSearchableIndices(List<String> list) API name:non_searchable_indicesfinal FieldCapability.Buildersearchable(boolean value) Required - Whether this field is indexed for search on all indexes.final FieldCapability.BuilderRequired - API name:typeMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<FieldCapability.Builder,FieldCapability> - Returns:
- a new builder instance.
-
aggregatable
Required - Whether this field can be aggregated on all indexes.API name:
aggregatable -
indices
API name:indicesAdds all elements of
listtoindices. -
indices
API name:indicesAdds one or more values to
indices. -
meta
API name:metaAdds all elements of
maptometa. -
meta
API name:metaAdds an entry to
meta. -
metadataField
Whether this field is registered as a metadata field.API name:
metadata_field -
nonAggregatableIndices
API name:non_aggregatable_indicesAdds all elements of
listtononAggregatableIndices. -
nonAggregatableIndices
@Nonnull public final FieldCapability.Builder nonAggregatableIndices(String value, String... values) API name:non_aggregatable_indicesAdds one or more values to
nonAggregatableIndices. -
nonSearchableIndices
API name:non_searchable_indicesAdds all elements of
listtononSearchableIndices. -
nonSearchableIndices
API name:non_searchable_indicesAdds one or more values to
nonSearchableIndices. -
searchable
Required - Whether this field is indexed for search on all indexes.API name:
searchable -
type
Required - API name:type -
build
Builds aFieldCapability.- Specified by:
buildin interfaceObjectBuilder<FieldCapability>- Throws:
NullPointerException- if some of the required fields are null.
-