Package org.opensearch.client.opensearch.task

Class State.Builder

java.lang.Object

org.opensearch.client.opensearch.task.State.Builder

All Implemented Interfaces:

ObjectBuilder<State>

Enclosing class:

State

public static class State.Builder
extends java.lang.Object
implements ObjectBuilder<State>

Builder for State.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
State.Builder	action(java.lang.String value)	API name: action
State	build()	Builds a State.
State.Builder	cancellable(java.lang.Boolean value)	API name: cancellable
State.Builder	description(java.lang.String value)	API name: description
State.Builder	headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> value)	API name: headers
State.Builder	id(java.lang.Number value)	API name: id
State.Builder	node(java.lang.String value)	API name: node
State.Builder	parentTaskId(jakarta.json.JsonValue value)	API name: parent_task_id
State.Builder	putHeaders(java.lang.String key, java.util.List<java.lang.String> value)	Add a key/value to headers(Map), creating the map if needed.
State.Builder	runningTimeInNanos(java.lang.Number value)	API name: running_time_in_nanos
State.Builder	startTimeInMillis(java.lang.Number value)	API name: start_time_in_millis
State.Builder	status(java.util.function.Function<Status.Builder,ObjectBuilder<Status>> fn)	API name: status
State.Builder	status(Status value)	API name: status
State.Builder	type(java.lang.String value)	API name: type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

action

public State.Builder action(java.lang.String value)

API name: action

cancellable

public State.Builder cancellable(java.lang.Boolean value)

API name: cancellable

description

public State.Builder description(@Nullable java.lang.String value)

API name: description

headers

public State.Builder headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> value)

API name: headers

putHeaders

public State.Builder putHeaders(java.lang.String key, java.util.List<java.lang.String> value)

Add a key/value to headers(Map), creating the map if needed.

id

public State.Builder id(java.lang.Number value)

API name: id

node

public State.Builder node(java.lang.String value)

API name: node

parentTaskId

public State.Builder parentTaskId(@Nullable jakarta.json.JsonValue value)

API name: parent_task_id

runningTimeInNanos

public State.Builder runningTimeInNanos(java.lang.Number value)

API name: running_time_in_nanos

startTimeInMillis

public State.Builder startTimeInMillis(java.lang.Number value)

API name: start_time_in_millis

status

public State.Builder status(@Nullable Status value)

API name: status

status

public State.Builder status(java.util.function.Function<Status.Builder,ObjectBuilder<Status>> fn)

API name: status

type

public State.Builder type(java.lang.String value)

API name: type

build

public State build()

Builds a State.

Specified by:

build in interface ObjectBuilder<State>

Throws:

java.lang.NullPointerException - if some of the required fields are null.