Package co.elastic.clients.elasticsearch.core

Class GetReindexResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<GetReindexResponse.Builder>

co.elastic.clients.elasticsearch.core.GetReindexResponse.Builder

All Implemented Interfaces:

WithJson<GetReindexResponse.Builder>, ObjectBuilder<GetReindexResponse>

Enclosing class:

GetReindexResponse

public static class GetReindexResponse.Builder
extends WithJsonObjectBuilderBase<GetReindexResponse.Builder>
implements ObjectBuilder<GetReindexResponse>

Builder for GetReindexResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetReindexResponse	build()	Builds a GetReindexResponse.
final GetReindexResponse.Builder	cancelled(boolean value)	Required - Whether the reindex task has been cancelled.
final GetReindexResponse.Builder	completed(boolean value)	Required - Whether the reindex task has completed.
final GetReindexResponse.Builder	description(String value)	A sanitized description of the reindex operation (source and destination indices, and optionally remote host info).
final GetReindexResponse.Builder	error(ErrorCause value)	The error that caused the reindex task to fail, if any.
final GetReindexResponse.Builder	error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	The error that caused the reindex task to fail, if any.
final GetReindexResponse.Builder	id(String value)	Required - The ID of the reindex task.
final GetReindexResponse.Builder	response(ReindexTaskResult value)	The final result of the completed reindex operation, if the task has finished successfully.
final GetReindexResponse.Builder	response(Function<ReindexTaskResult.Builder,ObjectBuilder<ReindexTaskResult>> fn)	The final result of the completed reindex operation, if the task has finished successfully.
final GetReindexResponse.Builder	runningTime(Time value)	The elapsed running time of the reindex task, in a human-readable format.
final GetReindexResponse.Builder	runningTime(Function<Time.Builder,ObjectBuilder<Time>> fn)	The elapsed running time of the reindex task, in a human-readable format.
final GetReindexResponse.Builder	runningTimeInNanos(long value)	Required - The elapsed running time of the reindex task, in nanoseconds.
protected GetReindexResponse.Builder	self()
final GetReindexResponse.Builder	startTime(String value)	The time at which the reindex task started, as an ISO 8601 formatted string.
final GetReindexResponse.Builder	startTimeInMillis(long value)	Required - The time at which the reindex task started, in milliseconds since the Unix epoch.
final GetReindexResponse.Builder	status(ReindexStatus value)	The current progress of the reindex operation.
final GetReindexResponse.Builder	status(Function<ReindexStatus.Builder,ObjectBuilder<ReindexStatus>> fn)	The current progress of the reindex operation.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

completed

public final GetReindexResponse.Builder completed(boolean value)

Required - Whether the reindex task has completed.

API name: completed

id

public final GetReindexResponse.Builder id(String value)

Required - The ID of the reindex task. The value is the ID assigned when the task was first created and remains stable across node-shutdown relocations.

API name: id

description

public final GetReindexResponse.Builder description(@Nullable
 String value)

A sanitized description of the reindex operation (source and destination indices, and optionally remote host info).

API name: description

startTimeInMillis

public final GetReindexResponse.Builder startTimeInMillis(long value)

Required - The time at which the reindex task started, in milliseconds since the Unix epoch.

API name: start_time_in_millis

startTime

public final GetReindexResponse.Builder startTime(@Nullable
 String value)

The time at which the reindex task started, as an ISO 8601 formatted string. Only present when the request includes the ?human=true query parameter.

API name: start_time

runningTime

public final GetReindexResponse.Builder runningTime(@Nullable
 Time value)

The elapsed running time of the reindex task, in a human-readable format. Only present when the request includes the ?human=true query parameter.

API name: running_time

runningTime

public final GetReindexResponse.Builder runningTime(Function<Time.Builder,ObjectBuilder<Time>> fn)

The elapsed running time of the reindex task, in a human-readable format. Only present when the request includes the ?human=true query parameter.

API name: running_time

runningTimeInNanos

public final GetReindexResponse.Builder runningTimeInNanos(long value)

Required - The elapsed running time of the reindex task, in nanoseconds.

API name: running_time_in_nanos

cancelled

public final GetReindexResponse.Builder cancelled(boolean value)

Required - Whether the reindex task has been cancelled.

API name: cancelled

status

public final GetReindexResponse.Builder status(@Nullable
 ReindexStatus value)

The current progress of the reindex operation.

API name: status

status

public final GetReindexResponse.Builder status(Function<ReindexStatus.Builder,ObjectBuilder<ReindexStatus>> fn)

The current progress of the reindex operation.

API name: status

error

public final GetReindexResponse.Builder error(@Nullable
 ErrorCause value)

The error that caused the reindex task to fail, if any.

API name: error

error

public final GetReindexResponse.Builder error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)

The error that caused the reindex task to fail, if any.

API name: error

response

public final GetReindexResponse.Builder response(@Nullable
 ReindexTaskResult value)

The final result of the completed reindex operation, if the task has finished successfully.

API name: response

response

public final GetReindexResponse.Builder response(Function<ReindexTaskResult.Builder,ObjectBuilder<ReindexTaskResult>> fn)

The final result of the completed reindex operation, if the task has finished successfully.

API name: response

self

protected GetReindexResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GetReindexResponse.Builder>

build

public GetReindexResponse build()

Builds a GetReindexResponse.

Specified by:

build in interface ObjectBuilder<GetReindexResponse>

Throws:

NullPointerException - if some of the required fields are null.