Class ExplainAnalyzeToken.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.analyze.ExplainAnalyzeToken.Builder
- All Implemented Interfaces:
CopyableBuilder<ExplainAnalyzeToken.Builder,,ExplainAnalyzeToken> MutableBuilder<ExplainAnalyzeToken.Builder,,ExplainAnalyzeToken> ObjectBuilder<ExplainAnalyzeToken>
- Enclosing class:
ExplainAnalyzeToken
public static class ExplainAnalyzeToken.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ExplainAnalyzeToken.Builder,ExplainAnalyzeToken>
Builder for
ExplainAnalyzeToken.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aExplainAnalyzeToken.Required - The bytes representation of the token.copy()Create a new builderCopyableBuilderthat is a copy of this one.endOffset(int value) Required - The ending character offset of the token.Whether the token is a keyword.position(int value) Required - The position of the token.positionLength(int value) Required - The length of the token position.startOffset(int value) Required - The starting character offset of the token.termFrequency(int value) Required - The frequency of the term.Required - The token string.Required - The type of the token.Methods 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<ExplainAnalyzeToken.Builder,ExplainAnalyzeToken> - Returns:
- a new builder instance.
-
bytes
Required - The bytes representation of the token.API name:
bytes -
endOffset
Required - The ending character offset of the token.API name:
end_offset -
keyword
Whether the token is a keyword.API name:
keyword -
position
Required - The position of the token.API name:
position -
positionLength
Required - The length of the token position.API name:
positionLength -
startOffset
Required - The starting character offset of the token.API name:
start_offset -
termFrequency
Required - The frequency of the term.API name:
termFrequency -
token
Required - The token string.API name:
token -
type
Required - The type of the token.API name:
type -
build
Builds aExplainAnalyzeToken.- Specified by:
buildin interfaceObjectBuilder<ExplainAnalyzeToken>- Throws:
NullPointerException- if some of the required fields are null.
-