Module org.elasticsearch.server

Package org.elasticsearch.action.datastreams.lifecycle

Class PutDataStreamLifecycleAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

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

org.elasticsearch.action.datastreams.lifecycle.PutDataStreamLifecycleAction.Request

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

Enclosing class:

PutDataStreamLifecycleAction

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutDataStreamLifecycleAction.Request.Factory

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.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

Modifier and Type	Field	Description
static final ConstructingObjectParser<PutDataStreamLifecycleAction.Request,PutDataStreamLifecycleAction.Request.Factory>	PARSER

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, String[] names, DataStreamLifecycle lifecycle)
Request(TimeValue masterNodeTimeout, TimeValue ackTimeout, String[] names, TimeValue dataRetention)
Request(TimeValue masterNodeTimeout, TimeValue ackTimeout, String[] names, TimeValue dataRetention, Boolean enabled)
Request(TimeValue masterNodeTimeout, TimeValue ackTimeout, String[] names, TimeValue dataRetention, Boolean enabled, DataStreamLifecycle.Downsampling downsampling)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DataStreamLifecycle	getLifecycle()
String[]	getNames()
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
IndicesRequest	indices(String... names)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
PutDataStreamLifecycleAction.Request	indicesOptions(IndicesOptions indicesOptions)
static PutDataStreamLifecycleAction.Request	parseRequest(XContentParser parser, PutDataStreamLifecycleAction.Request.Factory factory)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

ackTimeout, ackTimeout, validate

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.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final ConstructingObjectParser<PutDataStreamLifecycleAction.Request,PutDataStreamLifecycleAction.Request.Factory> PARSER

Constructor Details

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String[] names,
 @Nullable
 TimeValue dataRetention)

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String[] names,
 DataStreamLifecycle lifecycle)

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String[] names,
 @Nullable
 TimeValue dataRetention,
 @Nullable
 Boolean enabled)

Request

public Request(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String[] names,
 @Nullable
 TimeValue dataRetention,
 @Nullable
 Boolean enabled,
 @Nullable
 DataStreamLifecycle.Downsampling downsampling)

Method Details

parseRequest

public static PutDataStreamLifecycleAction.Request parseRequest(XContentParser parser,
 PutDataStreamLifecycleAction.Request.Factory factory)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<PutDataStreamLifecycleAction.Request>

Throws:

IOException

getNames

public String[] getNames()

getLifecycle

public DataStreamLifecycle getLifecycle()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public PutDataStreamLifecycleAction.Request indicesOptions(IndicesOptions indicesOptions)

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

indices

public IndicesRequest indices(String... names)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable