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

Class FieldAndFormat.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.FieldAndFormat.Builder

All Implemented Interfaces:

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

Enclosing class:

FieldAndFormat

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

Builder for FieldAndFormat.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldAndFormat	build()	Builds a FieldAndFormat.
FieldAndFormat.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FieldAndFormat.Builder	field(String value)	Required - API name: field
final FieldAndFormat.Builder	format(String value)	Format in which the values are returned.
final FieldAndFormat.Builder	includeUnmapped(Boolean value)	API name: include_unmapped

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

Returns:

a new builder instance.

field

@Nonnull
public final FieldAndFormat.Builder field(String value)

Required - API name: field

format

@Nonnull
public final FieldAndFormat.Builder format(@Nullable
 String value)

Format in which the values are returned.

API name: format

includeUnmapped

@Nonnull
public final FieldAndFormat.Builder includeUnmapped(@Nullable
 Boolean value)

API name: include_unmapped

build

@Nonnull
public FieldAndFormat build()

Builds a FieldAndFormat.

Specified by:

build in interface ObjectBuilder<FieldAndFormat>

Throws:

NullPointerException - if some of the required fields are null.