PinnedDoc.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch._types.query_dsl.PinnedDoc.Builder

All Implemented Interfaces:: ObjectBuilder<PinnedDoc>

Enclosing class:: PinnedDoc

public static class PinnedDoc.Builder
extends ObjectBuilderBase
implements ObjectBuilder<PinnedDoc>

Builder for PinnedDoc.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PinnedDoc`	`build()`	Builds a `PinnedDoc`.
`PinnedDoc.Builder`	`id(java.lang.String value)`	Required - API name: `_id`
`PinnedDoc.Builder`	`index(java.lang.String value)`	Required - API name: `_index`

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public final PinnedDoc.Builder id(java.lang.String value)
```
    Required - API name: _id
  - index
```
public final PinnedDoc.Builder index(java.lang.String value)
```
    Required - API name: _index
  - build
```
public PinnedDoc build()
```
    Builds a PinnedDoc.
    
    Specified by:
    
    build in interface ObjectBuilder<PinnedDoc>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.