Package org.opensearch.client.opensearch._types

Class CompletionStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.CompletionStats.Builder

All Implemented Interfaces:

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

Enclosing class:

CompletionStats

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

Builder for CompletionStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CompletionStats	build()	Builds a CompletionStats.
CompletionStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CompletionStats.Builder	fields(String key, Function<FieldSizeUsage.Builder,ObjectBuilder<FieldSizeUsage>> fn)	The per-field completion statistics.
final CompletionStats.Builder	fields(String key, FieldSizeUsage value)	The per-field completion statistics.
final CompletionStats.Builder	fields(Map<String,FieldSizeUsage> map)	The per-field completion statistics.
final CompletionStats.Builder	size(String value)	The human-readable size of memory used for completion.
final CompletionStats.Builder	sizeInBytes(long value)	Required - The total amount, in bytes, of memory used for completion across all shards assigned to the selected nodes.

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

Returns:

a new builder instance.

fields

@Nonnull
public final CompletionStats.Builder fields(Map<String,FieldSizeUsage> map)

The per-field completion statistics.

API name: fields

Adds all elements of map to fields.

fields

@Nonnull
public final CompletionStats.Builder fields(String key,
 FieldSizeUsage value)

The per-field completion statistics.

API name: fields

Adds an entry to fields.

fields

@Nonnull
public final CompletionStats.Builder fields(String key,
 Function<FieldSizeUsage.Builder,ObjectBuilder<FieldSizeUsage>> fn)

The per-field completion statistics.

API name: fields

Adds a value to fields using a builder lambda.

size

@Nonnull
public final CompletionStats.Builder size(@Nullable
 String value)

The human-readable size of memory used for completion.

API name: size

sizeInBytes

@Nonnull
public final CompletionStats.Builder sizeInBytes(long value)

Required - The total amount, in bytes, of memory used for completion across all shards assigned to the selected nodes.

API name: size_in_bytes

build

@Nonnull
public CompletionStats build()

Builds a CompletionStats.

Specified by:

build in interface ObjectBuilder<CompletionStats>

Throws:

NullPointerException - if some of the required fields are null.