Headers.Builder (java-client 2.23.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.ml.Headers.Builder

All Implemented Interfaces:

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

Enclosing class:

Headers
```
public static class Headers.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Headers.Builder,Headers>
```
Builder for Headers.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Headers`	`build()`	Builds a `Headers`.
`Headers.Builder`	`contentType(java.lang.String value)`	API name: `content_type`
`Headers.Builder`	`copy()`	Create a new builder `CopyableBuilder` that is a copy of this one.
`Headers.Builder`	`metadata(java.lang.String key, JsonData value)`	Adds an entry to `metadata`.
`Headers.Builder`	`metadata(java.util.Map<java.lang.String,JsonData> map)`	Adds all elements of `map` to `metadata`.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail
  - Builder
```
public Builder()
```
- Method Detail
  - copy
```
@Nonnull
public Headers.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<Headers.Builder,Headers>
    
    Returns:
    
    a new builder instance.
  - contentType
```
@Nonnull
public final Headers.Builder contentType(@Nullable
                                         java.lang.String value)
```
    API name: content_type
  - metadata
```
@Nonnull
public final Headers.Builder metadata(java.util.Map<java.lang.String,JsonData> map)
```
    Adds all elements of map to metadata.
  - metadata
```
@Nonnull
public final Headers.Builder metadata(java.lang.String key,
                                      JsonData value)
```
    Adds an entry to metadata.
  - build
```
@Nonnull
public Headers build()
```
    Builds a Headers.
    
    Specified by:
    
    build in interface ObjectBuilder<Headers>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.