Class IndicesValidationExplanation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.validate_query.IndicesValidationExplanation.Builder
- All Implemented Interfaces:
CopyableBuilder<IndicesValidationExplanation.Builder,,IndicesValidationExplanation> MutableBuilder<IndicesValidationExplanation.Builder,,IndicesValidationExplanation> ObjectBuilder<IndicesValidationExplanation>
- Enclosing class:
IndicesValidationExplanation
public static class IndicesValidationExplanation.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IndicesValidationExplanation.Builder,IndicesValidationExplanation>
Builder for
IndicesValidationExplanation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aIndicesValidationExplanation.copy()Create a new builderCopyableBuilderthat is a copy of this one.The error message if validation failed.explanation(String value) The explanation of why the query is valid or invalid.Required - API name:indexvalid(boolean value) Required - Whether the query is valid for the index.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<IndicesValidationExplanation.Builder,IndicesValidationExplanation> - Returns:
- a new builder instance.
-
error
The error message if validation failed.API name:
error -
explanation
The explanation of why the query is valid or invalid.API name:
explanation -
index
Required - API name:index -
valid
Required - Whether the query is valid for the index.API name:
valid -
build
Builds aIndicesValidationExplanation.- Specified by:
buildin interfaceObjectBuilder<IndicesValidationExplanation>- Throws:
NullPointerException- if some of the required fields are null.
-