Package org.opensearch.action.search

Class CreatePitRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.search.CreatePitRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, TaskAwareRequest

@PublicApi(since="2.3.0")
public class CreatePitRequest
extends ActionRequest
implements IndicesRequest.Replaceable, org.opensearch.core.xcontent.ToXContent

A request to make create point in time against one or more indices.

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

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

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CreatePitRequest(org.opensearch.common.unit.TimeValue keepAlive, Boolean allowPartialPitCreation, String... indices)
CreatePitRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	allowPartialPitCreation(Boolean allowPartialPitCreation)	Sets if this request should allow partial results.
final String	buildDescription()
Task	createTask(long id, String type, String action, org.opensearch.core.tasks.TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
String[]	getIndices()
IndicesOptions	getIndicesOptions()
org.opensearch.common.unit.TimeValue	getKeepAlive()
String	getPreference()
String	getRouting()
String[]	indices()	Returns the array of indices that the action relates to
CreatePitRequest	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
CreatePitRequest	indicesOptions(IndicesOptions indicesOptions)
void	setIndices(String[] indices)
void	setIndicesOptions(IndicesOptions indicesOptions)
void	setKeepAlive(org.opensearch.common.unit.TimeValue keepAlive)
void	setPreference(String preference)
void	setRouting(String routing)
boolean	shouldAllowPartialPitCreation()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

getDescription, setParentTask

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

isFragment

Constructor Details

CreatePitRequest

public CreatePitRequest(org.opensearch.common.unit.TimeValue keepAlive,
 Boolean allowPartialPitCreation,
 String... indices)

CreatePitRequest

public CreatePitRequest(org.opensearch.core.common.io.stream.StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

getRouting

public String getRouting()

getPreference

public String getPreference()

getIndices

public String[] getIndices()

getIndicesOptions

public IndicesOptions getIndicesOptions()

getKeepAlive

public org.opensearch.common.unit.TimeValue getKeepAlive()

allowPartialPitCreation

public void allowPartialPitCreation(Boolean allowPartialPitCreation)

Sets if this request should allow partial results.

shouldAllowPartialPitCreation

public boolean shouldAllowPartialPitCreation()

setRouting

public void setRouting(String routing)

setPreference

public void setPreference(String preference)

setIndices

public void setIndices(String[] indices)

setIndicesOptions

public void setIndicesOptions(IndicesOptions indicesOptions)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 CreatePitRequest indicesOptions(IndicesOptions indicesOptions)

setKeepAlive

public void setKeepAlive(org.opensearch.common.unit.TimeValue keepAlive)

buildDescription

public final String buildDescription()

createTask

public Task createTask(long id,
 String type,
 String action,
 org.opensearch.core.tasks.TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

Specified by:

createTask in interface TaskAwareRequest

indices

public CreatePitRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException