Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class ClosePointInTimeRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.search.ClosePointInTimeRequest

All Implemented Interfaces:

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

public class ClosePointInTimeRequest
extends UntypedActionRequest
implements ToXContentObject, IndicesRequest.CrossProjectCandidate

Nested Class Summary

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 interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ClosePointInTimeRequest(BytesReference id)
ClosePointInTimeRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	allowsCrossProject()	Determines whether the request type can support cross-project processing.
static ClosePointInTimeRequest	fromXContent(XContentParser parser)
BytesReference	getId()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

ClosePointInTimeRequest

public ClosePointInTimeRequest(StreamInput in)
                        throws IOException

Throws:

IOException

ClosePointInTimeRequest

public ClosePointInTimeRequest(BytesReference id)

Method Details

getId

public BytesReference getId()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 ActionRequest

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ClosePointInTimeRequest fromXContent(XContentParser parser)
                                            throws IOException

Throws:

IOException

allowsCrossProject

public boolean allowsCrossProject()

Description copied from interface: IndicesRequest.CrossProjectCandidate

Determines whether the request type can support cross-project processing. Cross-project processing entails 1. UIAM authentication and authorization projects resolution. 2. If applicable, cross-project flat-world index resolution and error handling Note: this method only determines in the request _supports_ cross-project. Whether cross-project processing is actually performed depends on other factors such as: - Whether CPS is enabled which impacts both 1 and 2. - Whether IndicesOptions supports it when the request is an IndicesRequest. This only impacts 2. See also CrossProjectModeDecider.

Specified by:

allowsCrossProject in interface IndicesRequest.CrossProjectCandidate