Class PutTransformRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.transform.PutTransformRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<PutTransformRequest>
- Enclosing class:
- PutTransformRequest
public static class PutTransformRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<PutTransformRequest>
Builder for
PutTransformRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description PutTransformRequest
build()
Builds aPutTransformRequest
.PutTransformRequest.Builder
deferValidation(java.lang.Boolean value)
When the transform is created, a series of validations occur to ensure its success.PutTransformRequest.Builder
description(java.lang.String value)
Free text description of the transform.PutTransformRequest.Builder
dest(Destination value)
Required - The destination for the transform.PutTransformRequest.Builder
dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)
Required - The destination for the transform.PutTransformRequest.Builder
frequency(Time value)
The interval between checks for changes in the source indices when the transform is running continuously.PutTransformRequest.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.PutTransformRequest.Builder
latest(Latest value)
The latest method transforms the data by finding the latest document for each unique key.PutTransformRequest.Builder
latest(java.util.function.Function<Latest.Builder,ObjectBuilder<Latest>> fn)
The latest method transforms the data by finding the latest document for each unique key.PutTransformRequest.Builder
meta(java.lang.String key, java.lang.String value)
Defines optional transform metadata.PutTransformRequest.Builder
meta(java.util.Map<java.lang.String,java.lang.String> map)
Defines optional transform metadata.PutTransformRequest.Builder
pivot(Pivot value)
The pivot method transforms the data by aggregating and grouping it.PutTransformRequest.Builder
pivot(java.util.function.Function<Pivot.Builder,ObjectBuilder<Pivot>> fn)
The pivot method transforms the data by aggregating and grouping it.PutTransformRequest.Builder
retentionPolicy(RetentionPolicy value)
Defines a retention policy for the transform.PutTransformRequest.Builder
retentionPolicy(java.util.function.Function<RetentionPolicy.Builder,ObjectBuilder<RetentionPolicy>> fn)
Defines a retention policy for the transform.PutTransformRequest.Builder
settings(Settings value)
Defines optional transform settings.PutTransformRequest.Builder
settings(java.util.function.Function<Settings.Builder,ObjectBuilder<Settings>> fn)
Defines optional transform settings.PutTransformRequest.Builder
source(Source value)
Required - The source of the data for the transform.PutTransformRequest.Builder
source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)
Required - The source of the data for the transform.PutTransformRequest.Builder
sync(Sync value)
Defines the properties transforms require to run continuously.PutTransformRequest.Builder
sync(java.util.function.Function<Sync.Builder,ObjectBuilder<Sync>> fn)
Defines the properties transforms require to run continuously.PutTransformRequest.Builder
timeout(Time value)
Period to wait for a response.PutTransformRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a response.PutTransformRequest.Builder
transformId(java.lang.String value)
Required - Identifier for the transform.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
meta
public final PutTransformRequest.Builder meta(java.util.Map<java.lang.String,java.lang.String> map)Defines optional transform metadata.API name:
_meta
Adds all entries of
map
tometa
. -
meta
Defines optional transform metadata.API name:
_meta
Adds an entry to
meta
. -
deferValidation
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
Free text description of the transform.API name:
description
-
dest
Required - The destination for the transform.API name:
dest
-
dest
public final PutTransformRequest.Builder dest(java.util.function.Function<Destination.Builder,ObjectBuilder<Destination>> fn)Required - The destination for the transform.API name:
dest
-
frequency
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 is1s
and the maximum is1h
.API name:
frequency
-
frequency
public final PutTransformRequest.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 is1s
and the maximum is1h
.API name:
frequency
-
latest
The latest method transforms the data by finding the latest document for each unique key.API name:
latest
-
latest
public final PutTransformRequest.Builder latest(java.util.function.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
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(java.util.function.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
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(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
Defines optional transform settings.API name:
settings
-
settings
public final PutTransformRequest.Builder settings(java.util.function.Function<Settings.Builder,ObjectBuilder<Settings>> fn)Defines optional transform settings.API name:
settings
-
source
Required - The source of the data for the transform.API name:
source
-
source
public final PutTransformRequest.Builder source(java.util.function.Function<Source.Builder,ObjectBuilder<Source>> fn)Required - The source of the data for the transform.API name:
source
-
sync
Defines the properties transforms require to run continuously.API name:
sync
-
sync
public final PutTransformRequest.Builder sync(java.util.function.Function<Sync.Builder,ObjectBuilder<Sync>> fn)Defines the properties transforms require to run continuously.API name:
sync
-
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
-
timeout
public final PutTransformRequest.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
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
-
build
Builds aPutTransformRequest
.- Specified by:
build
in interfaceObjectBuilder<PutTransformRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-