Package co.elastic.clients.elasticsearch.transform

Class ResetTransformRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.transform.ResetTransformRequest

public class ResetTransformRequest
extends RequestBase

Reset a transform.

Before you can reset it, you must stop it; alternatively, use the force query parameter. If the destination index was created by the transform, it is deleted.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResetTransformRequest.Builder	Builder for ResetTransformRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ResetTransformRequest,ResetTransformResponse,ErrorResponse>	_ENDPOINT	Endpoint "transform.reset_transform".

Method Summary

Modifier and Type	Method	Description
final Boolean	force()	If this value is true, the transform is reset regardless of its current state.
static ResetTransformRequest	of(Function<ResetTransformRequest.Builder,ObjectBuilder<ResetTransformRequest>> fn)
final Time	timeout()	Period to wait for a response.
final String	transformId()	Required - Identifier for the transform.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<ResetTransformRequest,ResetTransformResponse,ErrorResponse> _ENDPOINT

Endpoint "transform.reset_transform".

Method Details

of

public static ResetTransformRequest of(Function<ResetTransformRequest.Builder,ObjectBuilder<ResetTransformRequest>> fn)

force

@Nullable
public final Boolean force()

If this value is true, the transform is reset regardless of its current state. If it's false, the transform must be stopped before it can be reset.

API name: force

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

transformId

public final String transformId()

Required - Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.

API name: transform_id