Package org.opensearch.client.opensearch.core.get_script_context

Class ContextMethod.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.get_script_context.ContextMethod.Builder

All Implemented Interfaces:

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

Enclosing class:

ContextMethod

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

Builder for ContextMethod.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContextMethod	build()	Builds a ContextMethod.
ContextMethod.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ContextMethod.Builder	name(String value)	Required - API name: name
final ContextMethod.Builder	params(Function<ContextMethodParam.Builder,ObjectBuilder<ContextMethodParam>> fn)	Required - API name: params
final ContextMethod.Builder	params(List<ContextMethodParam> list)	Required - API name: params
final ContextMethod.Builder	params(ContextMethodParam value, ContextMethodParam... values)	Required - API name: params
final ContextMethod.Builder	returnType(String value)	Required - API name: return_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 ContextMethod.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<ContextMethod.Builder,ContextMethod>

Returns:

a new builder instance.

name

@Nonnull
public final ContextMethod.Builder name(String value)

Required - API name: name

params

@Nonnull
public final ContextMethod.Builder params(List<ContextMethodParam> list)

Required - API name: params

Adds all elements of list to params.

params

@Nonnull
public final ContextMethod.Builder params(ContextMethodParam value,
 ContextMethodParam... values)

Required - API name: params

Adds one or more values to params.

params

@Nonnull
public final ContextMethod.Builder params(Function<ContextMethodParam.Builder,ObjectBuilder<ContextMethodParam>> fn)

Required - API name: params

Adds a value to params using a builder lambda.

returnType

@Nonnull
public final ContextMethod.Builder returnType(String value)

Required - API name: return_type

build

@Nonnull
public ContextMethod build()

Builds a ContextMethod.

Specified by:

build in interface ObjectBuilder<ContextMethod>

Throws:

NullPointerException - if some of the required fields are null.