Package co.elastic.clients.elasticsearch.migration

Class ElasticsearchMigrationClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchMigrationClient>

co.elastic.clients.elasticsearch.migration.ElasticsearchMigrationClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchMigrationClient
extends ApiClient<ElasticsearchTransport,ElasticsearchMigrationClient>

Client for the migration namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchMigrationClient(ElasticsearchTransport transport)
ElasticsearchMigrationClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
DeprecationsResponse	deprecations()	Get deprecation information.
DeprecationsResponse	deprecations(DeprecationsRequest request)	Get deprecation information.
final DeprecationsResponse	deprecations(Function<DeprecationsRequest.Builder,ObjectBuilder<DeprecationsRequest>> fn)	Get deprecation information.
GetFeatureUpgradeStatusResponse	getFeatureUpgradeStatus()	Get feature migration information.
PostFeatureUpgradeResponse	postFeatureUpgrade()	Start the feature migration.
ElasticsearchMigrationClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElasticsearchMigrationClient

public ElasticsearchMigrationClient(ElasticsearchTransport transport)

ElasticsearchMigrationClient

public ElasticsearchMigrationClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchMigrationClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchMigrationClient>

deprecations

public DeprecationsResponse deprecations(DeprecationsRequest request)
                                  throws IOException,
ElasticsearchException

Get deprecation information.

Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version. You must address the reported issues before upgrading to the next major version. However, no action is required when upgrading within the current major version. Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version. Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.

info This API is designed for indirect use by the Upgrade Assistant. We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deprecations

public final DeprecationsResponse deprecations(Function<DeprecationsRequest.Builder,ObjectBuilder<DeprecationsRequest>> fn)
                                        throws IOException,
ElasticsearchException

Get deprecation information.

Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version. You must address the reported issues before upgrading to the next major version. However, no action is required when upgrading within the current major version. Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version. Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.

info This API is designed for indirect use by the Upgrade Assistant. We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.

Parameters:

fn - a function that initializes a builder to create the DeprecationsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deprecations

public DeprecationsResponse deprecations()
                                  throws IOException,
ElasticsearchException

Get deprecation information.

Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version. You must address the reported issues before upgrading to the next major version. However, no action is required when upgrading within the current major version. Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version. Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.

info This API is designed for indirect use by the Upgrade Assistant. We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getFeatureUpgradeStatus

public GetFeatureUpgradeStatusResponse getFeatureUpgradeStatus()
                                                        throws IOException,
ElasticsearchException

Get feature migration information.

Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postFeatureUpgrade

public PostFeatureUpgradeResponse postFeatureUpgrade()
                                              throws IOException,
ElasticsearchException

Start the feature migration.

Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process.

Some functionality might be temporarily unavailable during the migration process.

TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co