FieldAndFormat.Builder (java-client 2.8.0 API)

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

All Implemented Interfaces:: ObjectBuilder<FieldAndFormat>

Enclosing class:: FieldAndFormat

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

Builder for FieldAndFormat.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FieldAndFormat`	`build()`	Builds a `FieldAndFormat`.
`FieldAndFormat.Builder`	`field(java.lang.String value)`	Required - Wildcard pattern.
`FieldAndFormat.Builder`	`format(java.lang.String value)`	Format in which the values are returned.
`FieldAndFormat.Builder`	`includeUnmapped(java.lang.Boolean value)`	API name: `include_unmapped`

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
  - field
```
public final FieldAndFormat.Builder field(java.lang.String value)
```
    Required - Wildcard pattern. The request returns values for field names matching this pattern.
    API name: field
  - format
```
public final FieldAndFormat.Builder format(@Nullable
                                           java.lang.String value)
```
    Format in which the values are returned.
    API name: format
  - includeUnmapped
```
public final FieldAndFormat.Builder includeUnmapped(@Nullable
                                                    java.lang.Boolean value)
```
    API name: include_unmapped
  - build
```
public FieldAndFormat build()
```
    Builds a FieldAndFormat.
    
    Specified by:
    
    build in interface ObjectBuilder<FieldAndFormat>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.