DeleteTransformRequest (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.transform.DeleteTransformRequest

public class DeleteTransformRequest
extends RequestBase

Deletes a transform.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class DeleteTransformRequest.Builder
Builder for DeleteTransformRequest.

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 Endpoint<DeleteTransformRequest,DeleteTransformResponse,ErrorResponse> _ENDPOINT
Endpoint "transform.delete_transform".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`force()`	If this value is false, the transform must be stopped before it can be deleted.
`static DeleteTransformRequest`	`of(java.util.function.Function<DeleteTransformRequest.Builder,ObjectBuilder<DeleteTransformRequest>> fn)`
`Time`	`timeout()`	Period to wait for a response.
`java.lang.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<DeleteTransformRequest,DeleteTransformResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "transform.delete_transform".
Method Details
- of
  
  public static DeleteTransformRequest of(java.util.function.Function<DeleteTransformRequest.Builder,ObjectBuilder<DeleteTransformRequest>> fn)
- force
  
  @Nullable public final java.lang.Boolean force()
  
  If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state.
  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 java.lang.String transformId()
  
  Required - Identifier for the transform.
  API name: transform_id