Package co.elastic.clients.elasticsearch.core

Class CancelReindexResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.core.CancelReindexResponse.Builder

All Implemented Interfaces:

WithJson<CancelReindexResponse.Builder>, ObjectBuilder<CancelReindexResponse>

Enclosing class:

CancelReindexResponse

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

Builder for CancelReindexResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CancelReindexResponse.Builder	acknowledged(Boolean value)	Present and true when wait_for_completion=false.
CancelReindexResponse	build()	Builds a CancelReindexResponse.
final CancelReindexResponse.Builder	cancelled(Boolean value)	Whether the reindex task has been cancelled.
final CancelReindexResponse.Builder	completed(Boolean value)	Whether the reindex task has completed.
final CancelReindexResponse.Builder	description(String value)	A sanitized description of the reindex operation.
final CancelReindexResponse.Builder	error(ErrorCause value)	The error that caused the reindex task to fail, if any.
final CancelReindexResponse.Builder	error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	The error that caused the reindex task to fail, if any.
final CancelReindexResponse.Builder	id(String value)	The ID of the reindex task.
final CancelReindexResponse.Builder	response(ReindexTaskResult value)	The final result of the reindex operation, if it completed before being cancelled.
final CancelReindexResponse.Builder	response(Function<ReindexTaskResult.Builder,ObjectBuilder<ReindexTaskResult>> fn)	The final result of the reindex operation, if it completed before being cancelled.
final CancelReindexResponse.Builder	runningTime(Time value)	The elapsed running time of the reindex task, in a human-readable format.
final CancelReindexResponse.Builder	runningTime(Function<Time.Builder,ObjectBuilder<Time>> fn)	The elapsed running time of the reindex task, in a human-readable format.
final CancelReindexResponse.Builder	runningTimeInNanos(Long value)	The elapsed running time of the reindex task, in nanoseconds.
protected CancelReindexResponse.Builder	self()
final CancelReindexResponse.Builder	startTime(String value)	The time at which the reindex task started, as an ISO 8601 formatted string.
final CancelReindexResponse.Builder	startTimeInMillis(Long value)	The time at which the reindex task started, in milliseconds since the Unix epoch.
final CancelReindexResponse.Builder	status(ReindexStatus value)	The status of the reindex operation at the time of cancellation.
final CancelReindexResponse.Builder	status(Function<ReindexStatus.Builder,ObjectBuilder<ReindexStatus>> fn)	The status of the reindex operation at the time of cancellation.

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

acknowledged

public final CancelReindexResponse.Builder acknowledged(@Nullable
 Boolean value)

Present and true when wait_for_completion=false.

API name: acknowledged

completed

public final CancelReindexResponse.Builder completed(@Nullable
 Boolean value)

Whether the reindex task has completed. Present when wait_for_completion=true.

API name: completed

id

public final CancelReindexResponse.Builder id(@Nullable
 String value)

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. Present when wait_for_completion=true.

API name: id

description

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

A sanitized description of the reindex operation.

API name: description

startTimeInMillis

public final CancelReindexResponse.Builder startTimeInMillis(@Nullable
 Long value)

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

API name: start_time_in_millis

startTime

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

The time at which the reindex task started, as an ISO 8601 formatted string.

API name: start_time

runningTime

public final CancelReindexResponse.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 CancelReindexResponse.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 CancelReindexResponse.Builder runningTimeInNanos(@Nullable
 Long value)

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

API name: running_time_in_nanos

cancelled

public final CancelReindexResponse.Builder cancelled(@Nullable
 Boolean value)

Whether the reindex task has been cancelled.

API name: cancelled

status

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

The status of the reindex operation at the time of cancellation.

API name: status

status

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

The status of the reindex operation at the time of cancellation.

API name: status

error

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

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

API name: error

error

public final CancelReindexResponse.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 CancelReindexResponse.Builder response(@Nullable
 ReindexTaskResult value)

The final result of the reindex operation, if it completed before being cancelled.

API name: response

response

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

The final result of the reindex operation, if it completed before being cancelled.

API name: response

self

protected CancelReindexResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<CancelReindexResponse.Builder>

build

public CancelReindexResponse build()

Builds a CancelReindexResponse.

Specified by:

build in interface ObjectBuilder<CancelReindexResponse>

Throws:

NullPointerException - if some of the required fields are null.