Package org.opensearch.client.opensearch.indices.validate_query

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndicesValidationExplanation	build()	Builds a IndicesValidationExplanation.
IndicesValidationExplanation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndicesValidationExplanation.Builder	error(String value)	The error message if validation failed.
final IndicesValidationExplanation.Builder	explanation(String value)	The explanation of why the query is valid or invalid.
final IndicesValidationExplanation.Builder	index(String value)	Required - API name: index
final IndicesValidationExplanation.Builder	valid(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, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public IndicesValidationExplanation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<IndicesValidationExplanation.Builder,IndicesValidationExplanation>

Returns:

a new builder instance.

error

@Nonnull
public final IndicesValidationExplanation.Builder error(@Nullable
 String value)

The error message if validation failed.

API name: error

explanation

@Nonnull
public final IndicesValidationExplanation.Builder explanation(@Nullable
 String value)

The explanation of why the query is valid or invalid.

API name: explanation

index

@Nonnull
public final IndicesValidationExplanation.Builder index(String value)

Required - API name: index

valid

@Nonnull
public final IndicesValidationExplanation.Builder valid(boolean value)

Required - Whether the query is valid for the index.

API name: valid

build

@Nonnull
public IndicesValidationExplanation build()

Builds a IndicesValidationExplanation.

Specified by:

build in interface ObjectBuilder<IndicesValidationExplanation>

Throws:

NullPointerException - if some of the required fields are null.