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

Class Profile.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.Profile.Builder

All Implemented Interfaces:

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

Enclosing class:

Profile

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

Builder for Profile.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Profile	build()	Builds a Profile.
Profile.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Profile.Builder	shards(Function<ShardProfile.Builder,ObjectBuilder<ShardProfile>> fn)	Required - API name: shards
final Profile.Builder	shards(List<ShardProfile> list)	Required - API name: shards
final Profile.Builder	shards(ShardProfile value, ShardProfile... values)	Required - API name: shards

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

Returns:

a new builder instance.

shards

@Nonnull
public final Profile.Builder shards(List<ShardProfile> list)

Required - API name: shards

Adds all elements of list to shards.

shards

@Nonnull
public final Profile.Builder shards(ShardProfile value,
 ShardProfile... values)

Required - API name: shards

Adds one or more values to shards.

shards

@Nonnull
public final Profile.Builder shards(Function<ShardProfile.Builder,ObjectBuilder<ShardProfile>> fn)

Required - API name: shards

Adds a value to shards using a builder lambda.

build

@Nonnull
public Profile build()

Builds a Profile.

Specified by:

build in interface ObjectBuilder<Profile>

Throws:

NullPointerException - if some of the required fields are null.