Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ccr.action

Class PutFollowAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<PutFollowAction.Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<PutFollowAction.Request>

org.elasticsearch.xpack.core.ccr.action.PutFollowAction.Request

All Implemented Interfaces:

IndicesRequest, Writeable, RefCounted, TaskAwareRequest, TransportRequest, ToXContent, ToXContentObject

Enclosing class:

PutFollowAction

public static final class PutFollowAction.Request
extends AcknowledgedRequest<PutFollowAction.Request>
implements IndicesRequest, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

AcknowledgedRequest.Plain

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.CrossProjectCandidate, IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUT

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Request(StreamInput in)
Request(TimeValue masterNodeTimeout, TimeValue ackTimeout)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static PutFollowAction.Request	fromXContent(TimeValue masterNodeTimeout, TimeValue ackTimeout, XContentParser parser)
String	getDataStreamName()
String	getFollowerIndex()
String	getLeaderIndex()
FollowParameters	getParameters()
String	getRemoteCluster()
Settings	getSettings()
int	hashCode()
String[]	indices()
IndicesOptions	indicesOptions()
void	setDataStreamName(String dataStreamName)
void	setFollowerIndex(String followerIndex)
void	setLeaderIndex(String leaderIndex)
void	setParameters(FollowParameters parameters)
void	setRemoteCluster(String remoteCluster)
void	setSettings(Settings settings)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
ActiveShardCount	waitForActiveShards()
void	waitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for follower index creation to return.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, ackTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterTerm

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout)

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

fromXContent

public static PutFollowAction.Request fromXContent(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 XContentParser parser)
                                            throws IOException

Throws:

IOException

getFollowerIndex

public String getFollowerIndex()

setFollowerIndex

public void setFollowerIndex(String followerIndex)

getRemoteCluster

public String getRemoteCluster()

setRemoteCluster

public void setRemoteCluster(String remoteCluster)

getLeaderIndex

public String getLeaderIndex()

setLeaderIndex

public void setLeaderIndex(String leaderIndex)

getSettings

public Settings getSettings()

setSettings

public void setSettings(Settings settings)

getParameters

public FollowParameters getParameters()

setParameters

public void setParameters(FollowParameters parameters)

getDataStreamName

@Nullable
public String getDataStreamName()

setDataStreamName

public void setDataStreamName(String dataStreamName)

waitForActiveShards

public ActiveShardCount waitForActiveShards()

waitForActiveShards

public void waitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that should be active for follower index creation to return. Defaults to ActiveShardCount.NONE, which will not wait for any shards to be active. Set this value to ActiveShardCount.DEFAULT to wait for the primary shard to be active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning.

Parameters:

waitForActiveShards - number of active shard copies to wait on

validate

public ActionRequestValidationException validate()

Overrides:

validate in class AcknowledgedRequest<PutFollowAction.Request>

indices

public String[] indices()

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface IndicesRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<PutFollowAction.Request>

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object