Package co.elastic.clients.elasticsearch.transform

Class UpgradeTransformsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.transform.UpgradeTransformsRequest

public class UpgradeTransformsRequest
extends RequestBase

Upgrade all transforms.

Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.

If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished.

To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UpgradeTransformsRequest,UpgradeTransformsResponse,ErrorResponse>	_ENDPOINT	Endpoint "transform.upgrade_transforms".

Method Summary

Modifier and Type	Method	Description
final Boolean	dryRun()	When true, the request checks for updates but does not run them.
static UpgradeTransformsRequest	of(Function<UpgradeTransformsRequest.Builder,ObjectBuilder<UpgradeTransformsRequest>> fn)
final Time	timeout()	Period to wait for a response.

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<UpgradeTransformsRequest,UpgradeTransformsResponse,ErrorResponse> _ENDPOINT

Endpoint "transform.upgrade_transforms".

Method Details

of

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

dryRun

@Nullable
public final Boolean dryRun()

When true, the request checks for updates but does not run them.

API name: dry_run

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