Package org.opensearch.client.opensearch.ml

Class Output.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.Output.Builder

All Implemented Interfaces:

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

Enclosing class:

Output

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

Builder for Output.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Output	build()	Builds a Output.
final Output.Builder	byteBuffer(Function<ByteBuffer.Builder,ObjectBuilder<ByteBuffer>> fn)	API name: byte_buffer
final Output.Builder	byteBuffer(ByteBuffer value)	API name: byte_buffer
Output.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Output.Builder	data(Double value, Double... values)	Required - API name: data
final Output.Builder	data(List<Double> list)	Required - API name: data
final Output.Builder	dataType(String value)	The output data type.
final Output.Builder	name(String value)	The output name.
final Output.Builder	result(String value)	The output result.
final Output.Builder	shape(Long value, Long... values)	API name: shape
final Output.Builder	shape(List<Long> list)	API name: shape

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

Returns:

a new builder instance.

byteBuffer

@Nonnull
public final Output.Builder byteBuffer(@Nullable
 ByteBuffer value)

API name: byte_buffer

byteBuffer

@Nonnull
public final Output.Builder byteBuffer(Function<ByteBuffer.Builder,ObjectBuilder<ByteBuffer>> fn)

API name: byte_buffer

data

@Nonnull
public final Output.Builder data(List<Double> list)

Required - API name: data

Adds all elements of list to data.

data

@Nonnull
public final Output.Builder data(Double value,
 Double... values)

Required - API name: data

Adds one or more values to data.

dataType

@Nonnull
public final Output.Builder dataType(@Nullable
 String value)

The output data type.

API name: data_type

name

@Nonnull
public final Output.Builder name(@Nullable
 String value)

The output name.

API name: name

result

@Nonnull
public final Output.Builder result(@Nullable
 String value)

The output result.

API name: result

shape

@Nonnull
public final Output.Builder shape(List<Long> list)

API name: shape

Adds all elements of list to shape.

shape

@Nonnull
public final Output.Builder shape(Long value,
 Long... values)

API name: shape

Adds one or more values to shape.

build

@Nonnull
public Output build()

Builds a Output.

Specified by:

build in interface ObjectBuilder<Output>

Throws:

NullPointerException - if some of the required fields are null.