Package org.opensearch.client.opensearch._types.query_dsl

Class PinnedDoc.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.PinnedDoc.Builder

All Implemented Interfaces:

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

Enclosing class:

PinnedDoc

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

Builder for PinnedDoc.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PinnedDoc	build()	Builds a PinnedDoc.
PinnedDoc.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PinnedDoc.Builder	id(String value)	Required - API name: _id
final PinnedDoc.Builder	index(String value)	Required - API name: _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 PinnedDoc.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<PinnedDoc.Builder,PinnedDoc>

Returns:

a new builder instance.

id

@Nonnull
public final PinnedDoc.Builder id(String value)

Required - API name: _id

index

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

Required - API name: _index

build

@Nonnull
public PinnedDoc build()

Builds a PinnedDoc.

Specified by:

build in interface ObjectBuilder<PinnedDoc>

Throws:

NullPointerException - if some of the required fields are null.