Package co.elastic.clients.elasticsearch.indices

Class PromoteDataStreamRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.PromoteDataStreamRequest

public class PromoteDataStreamRequest
extends RequestBase

Promote a data stream. Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.

With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. These data streams can't be rolled over in the local cluster. These replicated data streams roll over only if the upstream data stream rolls over. In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.

NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. If this is missing, the data stream will not be able to roll over until a matching index template is created. This will affect the lifecycle management of the data stream and interfere with the data stream size and retention.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PromoteDataStreamRequest,PromoteDataStreamResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.promote_data_stream".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	name()	Required - The name of the data stream
static PromoteDataStreamRequest	of(Function<PromoteDataStreamRequest.Builder,ObjectBuilder<PromoteDataStreamRequest>> fn)

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<PromoteDataStreamRequest,PromoteDataStreamResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.promote_data_stream".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

public final String name()

Required - The name of the data stream

API name: name