Package co.elastic.clients.elasticsearch.transform

Class UpdateTransformRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<UpdateTransformRequest.Builder>

co.elastic.clients.elasticsearch.transform.UpdateTransformRequest.Builder

All Implemented Interfaces:

WithJson<UpdateTransformRequest.Builder>, ObjectBuilder<UpdateTransformRequest>

Enclosing class:

UpdateTransformRequest

public static class UpdateTransformRequest.Builder
extends RequestBase.AbstractBuilder<UpdateTransformRequest.Builder>
implements ObjectBuilder<UpdateTransformRequest>

Builder for UpdateTransformRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateTransformRequest	build()	Builds a UpdateTransformRequest.
UpdateTransformRequest.Builder	deferValidation(java.lang.Boolean value)	When true, deferrable validations are not run.
UpdateTransformRequest.Builder	description(java.lang.String value)	Free text description of the transform.
UpdateTransformRequest.Builder	dest(Destination value)	The destination for the transform.
UpdateTransformRequest.Builder	dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)	The destination for the transform.
UpdateTransformRequest.Builder	frequency(Time value)	The interval between checks for changes in the source indices when the transform is running continuously.
UpdateTransformRequest.Builder	frequency(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	The interval between checks for changes in the source indices when the transform is running continuously.
UpdateTransformRequest.Builder	meta(java.lang.String key, JsonData value)	Defines optional transform metadata.
UpdateTransformRequest.Builder	meta(java.util.Map<java.lang.String,JsonData> map)	Defines optional transform metadata.
UpdateTransformRequest.Builder	retentionPolicy(RetentionPolicy value)	Defines a retention policy for the transform.
UpdateTransformRequest.Builder	retentionPolicy(java.util.function.Function<RetentionPolicy.Builder,ObjectBuilder<RetentionPolicy>> fn)	Defines a retention policy for the transform.
protected UpdateTransformRequest.Builder	self()
UpdateTransformRequest.Builder	settings(Settings value)	Defines optional transform settings.
UpdateTransformRequest.Builder	settings(java.util.function.Function<Settings.Builder,ObjectBuilder<Settings>> fn)	Defines optional transform settings.
UpdateTransformRequest.Builder	source(Source value)	The source of the data for the transform.
UpdateTransformRequest.Builder	source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)	The source of the data for the transform.
UpdateTransformRequest.Builder	sync(Sync value)	Defines the properties transforms require to run continuously.
UpdateTransformRequest.Builder	sync(java.util.function.Function<Sync.Builder,ObjectBuilder<Sync>> fn)	Defines the properties transforms require to run continuously.
UpdateTransformRequest.Builder	timeout(Time value)	Period to wait for a response.
UpdateTransformRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
UpdateTransformRequest.Builder	transformId(java.lang.String value)	Required - Identifier for the transform.

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

meta

public final UpdateTransformRequest.Builder meta(java.util.Map<java.lang.String,JsonData> map)

Defines optional transform metadata.

API name: _meta

Adds all entries of map to meta.

meta

public final UpdateTransformRequest.Builder meta(java.lang.String key,
JsonData value)

Defines optional transform metadata.

API name: _meta

Adds an entry to meta.

deferValidation

public final UpdateTransformRequest.Builder deferValidation(@Nullable
java.lang.Boolean value)

When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.

API name: defer_validation

description

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

Free text description of the transform.

API name: description

dest

public final UpdateTransformRequest.Builder dest(@Nullable
Destination value)

The destination for the transform.

API name: dest

dest

public final UpdateTransformRequest.Builder dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)

The destination for the transform.

API name: dest

frequency

public final UpdateTransformRequest.Builder frequency(@Nullable
Time value)

The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.

API name: frequency

frequency

public final UpdateTransformRequest.Builder frequency(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h.

API name: frequency

retentionPolicy

public final UpdateTransformRequest.Builder retentionPolicy(@Nullable
RetentionPolicy value)

Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.

API name: retention_policy

retentionPolicy

public final UpdateTransformRequest.Builder retentionPolicy(java.util.function.Function<RetentionPolicy.Builder,ObjectBuilder<RetentionPolicy>> fn)

Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.

API name: retention_policy

settings

public final UpdateTransformRequest.Builder settings(@Nullable
Settings value)

Defines optional transform settings.

API name: settings

settings

public final UpdateTransformRequest.Builder settings(java.util.function.Function<Settings.Builder,ObjectBuilder<Settings>> fn)

Defines optional transform settings.

API name: settings

source

public final UpdateTransformRequest.Builder source(@Nullable
Source value)

The source of the data for the transform.

API name: source

source

public final UpdateTransformRequest.Builder source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)

The source of the data for the transform.

API name: source

sync

public final UpdateTransformRequest.Builder sync(@Nullable
Sync value)

Defines the properties transforms require to run continuously.

API name: sync

sync

public final UpdateTransformRequest.Builder sync(java.util.function.Function<Sync.Builder,ObjectBuilder<Sync>> fn)

Defines the properties transforms require to run continuously.

API name: sync

timeout

public final UpdateTransformRequest.Builder timeout(@Nullable
Time value)

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

timeout

public final UpdateTransformRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

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 UpdateTransformRequest.Builder transformId(java.lang.String value)

Required - Identifier for the transform.

API name: transform_id

self

protected UpdateTransformRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateTransformRequest.Builder>

build

public UpdateTransformRequest build()

Builds a UpdateTransformRequest.

Specified by:

build in interface ObjectBuilder<UpdateTransformRequest>

Throws:

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