Package org.opensearch.client.opensearch.ml

Class Task.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ml.Task.Builder

All Implemented Interfaces:

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

Enclosing class:

Task

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

Builder for Task.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Task	build()	Builds a Task.
Task.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Task.Builder	createTime(Long value)	API name: create_time
final Task.Builder	error(String value)	API name: error
final Task.Builder	functionName(FunctionName value)	API name: function_name
final Task.Builder	isAsync(Boolean value)	API name: is_async
final Task.Builder	lastUpdateTime(Long value)	API name: last_update_time
final Task.Builder	modelId(String value)	API name: model_id
final Task.Builder	state(String value)	Required - API name: state
final Task.Builder	taskId(String value)	API name: task_id
final Task.Builder	taskType(String value)	Task type.
final Task.Builder	workerNode(List<String> value, List<String>... values)	API name: worker_node
final Task.Builder	workerNode(List<List<String>> list)	API name: worker_node

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

Returns:

a new builder instance.

createTime

@Nonnull
public final Task.Builder createTime(@Nullable
 Long value)

API name: create_time

error

@Nonnull
public final Task.Builder error(@Nullable
 String value)

API name: error

functionName

@Nonnull
public final Task.Builder functionName(@Nullable
 FunctionName value)

API name: function_name

isAsync

@Nonnull
public final Task.Builder isAsync(@Nullable
 Boolean value)

API name: is_async

lastUpdateTime

@Nonnull
public final Task.Builder lastUpdateTime(@Nullable
 Long value)

API name: last_update_time

modelId

@Nonnull
public final Task.Builder modelId(@Nullable
 String value)

API name: model_id

state

@Nonnull
public final Task.Builder state(String value)

Required - API name: state

taskId

@Nonnull
public final Task.Builder taskId(@Nullable
 String value)

API name: task_id

taskType

@Nonnull
public final Task.Builder taskType(@Nullable
 String value)

Task type.

API name: task_type

workerNode

@Nonnull
public final Task.Builder workerNode(List<List<String>> list)

API name: worker_node

Adds all elements of list to workerNode.

workerNode

@Nonnull
public final Task.Builder workerNode(List<String> value,
 List<String>... values)

API name: worker_node

Adds one or more values to workerNode.

build

@Nonnull
public Task build()

Builds a Task.

Specified by:

build in interface ObjectBuilder<Task>

Throws:

NullPointerException - if some of the required fields are null.