Package org.opensearch.client.opensearch.core.search

Class QueryProfile.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.QueryProfile.Builder

All Implemented Interfaces:

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

Enclosing class:

QueryProfile

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

Builder for QueryProfile.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final QueryProfile.Builder	breakdown(Function<QueryBreakdown.Builder,ObjectBuilder<QueryBreakdown>> fn)	Required - API name: breakdown
final QueryProfile.Builder	breakdown(QueryBreakdown value)	Required - API name: breakdown
QueryProfile	build()	Builds a QueryProfile.
final QueryProfile.Builder	children(Function<QueryProfile.Builder,ObjectBuilder<QueryProfile>> fn)	API name: children
final QueryProfile.Builder	children(List<QueryProfile> list)	API name: children
final QueryProfile.Builder	children(QueryProfile value, QueryProfile... values)	API name: children
QueryProfile.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final QueryProfile.Builder	description(String value)	Required - API name: description
final QueryProfile.Builder	timeInNanos(long value)	Required - API name: time_in_nanos
final QueryProfile.Builder	type(String value)	Required - API name: type

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

Returns:

a new builder instance.

breakdown

@Nonnull
public final QueryProfile.Builder breakdown(QueryBreakdown value)

Required - API name: breakdown

breakdown

@Nonnull
public final QueryProfile.Builder breakdown(Function<QueryBreakdown.Builder,ObjectBuilder<QueryBreakdown>> fn)

Required - API name: breakdown

children

@Nonnull
public final QueryProfile.Builder children(List<QueryProfile> list)

API name: children

Adds all elements of list to children.

children

@Nonnull
public final QueryProfile.Builder children(QueryProfile value,
 QueryProfile... values)

API name: children

Adds one or more values to children.

children

@Nonnull
public final QueryProfile.Builder children(Function<QueryProfile.Builder,ObjectBuilder<QueryProfile>> fn)

API name: children

Adds a value to children using a builder lambda.

description

@Nonnull
public final QueryProfile.Builder description(String value)

Required - API name: description

timeInNanos

@Nonnull
public final QueryProfile.Builder timeInNanos(long value)

Required - API name: time_in_nanos

type

@Nonnull
public final QueryProfile.Builder type(String value)

Required - API name: type

build

@Nonnull
public QueryProfile build()

Builds a QueryProfile.

Specified by:

build in interface ObjectBuilder<QueryProfile>

Throws:

NullPointerException - if some of the required fields are null.