Package org.opensearch.client.opensearch._types

Class ShardSearchFailure.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.ShardSearchFailure.Builder

All Implemented Interfaces:

CopyableBuilder<ShardSearchFailure.Builder,ShardSearchFailure>, MutableBuilder<ShardSearchFailure.Builder,ShardSearchFailure>, ObjectBuilder<ShardSearchFailure>

Enclosing class:

ShardSearchFailure

public static class ShardSearchFailure.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ShardSearchFailure.Builder,ShardSearchFailure>

Builder for ShardSearchFailure.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardSearchFailure	build()	Builds a ShardSearchFailure.
ShardSearchFailure.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardSearchFailure.Builder	index(String value)	The index name where the failure occurred.
final ShardSearchFailure.Builder	node(String value)	The node id where the failure occurred.
final ShardSearchFailure.Builder	reason(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	Required - API name: reason
final ShardSearchFailure.Builder	reason(ErrorCause value)	Required - API name: reason
final ShardSearchFailure.Builder	shard(int value)	Required - The shard id where the failure occurred.

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 ShardSearchFailure.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<ShardSearchFailure.Builder,ShardSearchFailure>

Returns:

a new builder instance.

index

@Nonnull
public final ShardSearchFailure.Builder index(@Nullable
 String value)

The index name where the failure occurred.

API name: index

node

@Nonnull
public final ShardSearchFailure.Builder node(@Nullable
 String value)

The node id where the failure occurred.

API name: node

reason

@Nonnull
public final ShardSearchFailure.Builder reason(ErrorCause value)

Required - API name: reason

reason

@Nonnull
public final ShardSearchFailure.Builder reason(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)

Required - API name: reason

shard

@Nonnull
public final ShardSearchFailure.Builder shard(int value)

Required - The shard id where the failure occurred.

API name: shard

build

@Nonnull
public ShardSearchFailure build()

Builds a ShardSearchFailure.

Specified by:

build in interface ObjectBuilder<ShardSearchFailure>

Throws:

NullPointerException - if some of the required fields are null.