Module org.elasticsearch.xcontent

Package org.elasticsearch.xcontent

Interface XContentParserConfiguration

public interface XContentParserConfiguration

Configuration for XContentParser.

Field Summary

Fields

Modifier and Type	Field	Description
static final XContentParserConfiguration	EMPTY	Creates parsers that don't support XContentParser.namedObject(java.lang.Class<T>, java.lang.String, java.lang.Object), throw an exception when they see deprecated fields, that return the current version from XContentParser.getRestApiVersion(), and do no filtering.

Method Summary

Modifier and Type	Method	Description
DeprecationHandler	deprecationHandler()
boolean	includeSourceOnError()
NamedXContentRegistry	registry()
RestApiVersion	restApiVersion()
XContentParserConfiguration	withDeprecationHandler(DeprecationHandler deprecationHandler)	Replace the behavior of XContentParser when it encounters a deprecated field.
XContentParserConfiguration	withFiltering(String prefixPath, Set<String> includeStrings, Set<String> excludeStrings, boolean filtersMatchFieldNamesWithDots)	Replace the configured filtering.
XContentParserConfiguration	withFiltering(Set<String> includeStrings, Set<String> excludeStrings, boolean filtersMatchFieldNamesWithDots)
XContentParserConfiguration	withIncludeSourceOnError(boolean includeSourceOnError)	Disable to not include the source in case of parsing errors (defaults to true).
XContentParserConfiguration	withRegistry(NamedXContentRegistry registry)	Replace the registry backing XContentParser.namedObject(java.lang.Class<T>, java.lang.String, java.lang.Object).
XContentParserConfiguration	withRestApiVersion(RestApiVersion restApiVersion)	Replace the claimed RestApiVersion.

Field Details

EMPTY

static final XContentParserConfiguration EMPTY

Creates parsers that don't support XContentParser.namedObject(java.lang.Class<T>, java.lang.String, java.lang.Object), throw an exception when they see deprecated fields, that return the current version from XContentParser.getRestApiVersion(), and do no filtering.

Method Details

withIncludeSourceOnError

XContentParserConfiguration withIncludeSourceOnError(boolean includeSourceOnError)

Disable to not include the source in case of parsing errors (defaults to true).

includeSourceOnError

boolean includeSourceOnError()

withRegistry

XContentParserConfiguration withRegistry(NamedXContentRegistry registry)

Replace the registry backing XContentParser.namedObject(java.lang.Class<T>, java.lang.String, java.lang.Object).

registry

NamedXContentRegistry registry()

withDeprecationHandler

XContentParserConfiguration withDeprecationHandler(DeprecationHandler deprecationHandler)

Replace the behavior of XContentParser when it encounters a deprecated field.

deprecationHandler

DeprecationHandler deprecationHandler()

withRestApiVersion

XContentParserConfiguration withRestApiVersion(RestApiVersion restApiVersion)

Replace the claimed RestApiVersion.

restApiVersion

RestApiVersion restApiVersion()

withFiltering

XContentParserConfiguration withFiltering(Set<String> includeStrings,
 Set<String> excludeStrings,
 boolean filtersMatchFieldNamesWithDots)

withFiltering

XContentParserConfiguration withFiltering(String prefixPath,
 Set<String> includeStrings,
 Set<String> excludeStrings,
 boolean filtersMatchFieldNamesWithDots)

Replace the configured filtering.

Parameters:

prefixPath - The path to be prepended to each sub-path before applying the include/exclude rules. Specify null if parsing starts from the root.

includeStrings - A set of strings representing paths to include during filtering. If specified, only these paths will be included in parsing.

excludeStrings - A set of strings representing paths to exclude during filtering. If specified, these paths will be excluded from parsing.

filtersMatchFieldNamesWithDots - Indicates whether filters should match field names containing dots ('.') as part of the field name.