Package co.elastic.clients.elasticsearch.transform

Class PutTransformRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.transform.PutTransformRequest.Builder

All Implemented Interfaces:

WithJson<PutTransformRequest.Builder>, ObjectBuilder<PutTransformRequest>

Enclosing class:

PutTransformRequest

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

Builder for PutTransformRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutTransformRequest	build()	Builds a PutTransformRequest.
final PutTransformRequest.Builder	deferValidation(Boolean value)	When the transform is created, a series of validations occur to ensure its success.
final PutTransformRequest.Builder	description(String value)	Free text description of the transform.
final PutTransformRequest.Builder	dest(Destination value)	Required - The destination for the transform.
final PutTransformRequest.Builder	dest(Function<Destination.Builder,ObjectBuilder<Destination>> fn)	Required - The destination for the transform.
final PutTransformRequest.Builder	frequency(Time value)	The interval between checks for changes in the source indices when the transform is running continuously.
final PutTransformRequest.Builder	frequency(Function<Time.Builder,ObjectBuilder<Time>> fn)	The interval between checks for changes in the source indices when the transform is running continuously.
final PutTransformRequest.Builder	latest(Latest value)	The latest method transforms the data by finding the latest document for each unique key.
final PutTransformRequest.Builder	latest(Function<Latest.Builder,ObjectBuilder<Latest>> fn)	The latest method transforms the data by finding the latest document for each unique key.
final PutTransformRequest.Builder	meta(String key, JsonData value)	Defines optional transform metadata.
final PutTransformRequest.Builder	meta(Map<String,JsonData> map)	Defines optional transform metadata.
final PutTransformRequest.Builder	pivot(Pivot value)	The pivot method transforms the data by aggregating and grouping it.
final PutTransformRequest.Builder	pivot(Function<Pivot.Builder,ObjectBuilder<Pivot>> fn)	The pivot method transforms the data by aggregating and grouping it.
final PutTransformRequest.Builder	retentionPolicy(RetentionPolicy value)	Defines a retention policy for the transform.
final PutTransformRequest.Builder	retentionPolicy(Function<RetentionPolicy.Builder,ObjectBuilder<RetentionPolicy>> fn)	Defines a retention policy for the transform.
protected PutTransformRequest.Builder	self()
final PutTransformRequest.Builder	settings(Settings value)	Defines optional transform settings.
final PutTransformRequest.Builder	settings(Function<Settings.Builder,ObjectBuilder<Settings>> fn)	Defines optional transform settings.
final PutTransformRequest.Builder	source(Source value)	Required - The source of the data for the transform.
final PutTransformRequest.Builder	source(Function<Source.Builder,ObjectBuilder<Source>> fn)	Required - The source of the data for the transform.
final PutTransformRequest.Builder	sync(Sync value)	Defines the properties transforms require to run continuously.
final PutTransformRequest.Builder	sync(Function<Sync.Builder,ObjectBuilder<Sync>> fn)	Defines the properties transforms require to run continuously.
final PutTransformRequest.Builder	timeout(Time value)	Period to wait for a response.
final PutTransformRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final PutTransformRequest.Builder	transformId(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 PutTransformRequest.Builder meta(Map<String,JsonData> map)

Defines optional transform metadata.

API name: _meta

Adds all entries of map to meta.

meta

public final PutTransformRequest.Builder meta(String key,
 JsonData value)

Defines optional transform metadata.

API name: _meta

Adds an entry to meta.

deferValidation

public final PutTransformRequest.Builder deferValidation(@Nullable
 Boolean value)

When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks.

API name: defer_validation

description

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

Free text description of the transform.

API name: description

dest

public final PutTransformRequest.Builder dest(Destination value)

Required - The destination for the transform.

API name: dest

dest

public final PutTransformRequest.Builder dest(Function<Destination.Builder,ObjectBuilder<Destination>> fn)

Required - The destination for the transform.

API name: dest

frequency

public final PutTransformRequest.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 PutTransformRequest.Builder frequency(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

latest

public final PutTransformRequest.Builder latest(@Nullable
 Latest value)

The latest method transforms the data by finding the latest document for each unique key.

API name: latest

latest

public final PutTransformRequest.Builder latest(Function<Latest.Builder,ObjectBuilder<Latest>> fn)

The latest method transforms the data by finding the latest document for each unique key.

API name: latest

pivot

public final PutTransformRequest.Builder pivot(@Nullable
 Pivot value)

The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.

API name: pivot

pivot

public final PutTransformRequest.Builder pivot(Function<Pivot.Builder,ObjectBuilder<Pivot>> fn)

The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data.

API name: pivot

retentionPolicy

public final PutTransformRequest.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 PutTransformRequest.Builder retentionPolicy(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 PutTransformRequest.Builder settings(@Nullable
 Settings value)

Defines optional transform settings.

API name: settings

settings

public final PutTransformRequest.Builder settings(Function<Settings.Builder,ObjectBuilder<Settings>> fn)

Defines optional transform settings.

API name: settings

source

public final PutTransformRequest.Builder source(Source value)

Required - The source of the data for the transform.

API name: source

source

public final PutTransformRequest.Builder source(Function<Source.Builder,ObjectBuilder<Source>> fn)

Required - The source of the data for the transform.

API name: source

sync

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

Defines the properties transforms require to run continuously.

API name: sync

sync

public final PutTransformRequest.Builder sync(Function<Sync.Builder,ObjectBuilder<Sync>> fn)

Defines the properties transforms require to run continuously.

API name: sync

timeout

public final PutTransformRequest.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 PutTransformRequest.Builder timeout(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 PutTransformRequest.Builder transformId(String value)

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

self

protected PutTransformRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutTransformRequest.Builder>

build

public PutTransformRequest build()

Builds a PutTransformRequest.

Specified by:

build in interface ObjectBuilder<PutTransformRequest>

Throws:

NullPointerException - if some of the required fields are null.