Package org.opensearch.client.opensearch.core.pit

Class CreatePitRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.pit.CreatePitRequest

public class CreatePitRequest
extends RequestBase

Creates a Point In Time attribute on Search

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<CreatePitRequest,CreatePitResponse,ErrorResponse>	_ENDPOINT

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowPartialPitCreation()	Specifies whether to create a PIT with partial failures.
java.util.List<ExpandWildcard>	expandWildcards()	The type of index that can match the wildcard pattern.
Time	keepAlive()	Required - The amount of time to keep the PIT.
static CreatePitRequest	of(java.util.function.Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)
java.lang.String	preference()	The node or the shard used to perform the search.
java.lang.String	routing()	Specifies to route search requests to a specific shard.
java.util.List<java.lang.String>	targetIndexes()	Required - The name(s) of the target index(es) for the PIT.

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<CreatePitRequest,CreatePitResponse,ErrorResponse> _ENDPOINT

Method Detail

of

public static CreatePitRequest of(java.util.function.Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)

targetIndexes

public final java.util.List<java.lang.String> targetIndexes()

Required - The name(s) of the target index(es) for the PIT. May contain a comma-separated list or a wildcard index pattern.

API name: target_indexes

keepAlive

public final Time keepAlive()

Required - The amount of time to keep the PIT. Every time you access a PIT by using the Search API, the PIT lifetime is extended by the amount of time equal to the keep_alive parameter.

API name: keep_alive

preference

@Nullable
public final java.lang.String preference()

The node or the shard used to perform the search. Optional. Default is random.

API name: preference

routing

@Nullable
public final java.lang.String routing()

Specifies to route search requests to a specific shard. Optional. Default is the document’s _id.

API name: routing

expandWildcards

@Nullable
public final java.util.List<ExpandWildcard> expandWildcards()

The type of index that can match the wildcard pattern. Supports comma-separated values. Valid values are the following: - all: Match any index or data stream, including hidden ones. - open: Match open, non-hidden indexes or non-hidden data streams. - closed: Match closed, non-hidden indexes or non-hidden data streams. - hidden: Match hidden indexes or data streams. Must be combined with open, closed or both open and closed. - none: No wildcard patterns are accepted. Optional. Default is open.

API name: expand_wildcards

allowPartialPitCreation

@Nullable
public final java.lang.Boolean allowPartialPitCreation()

Specifies whether to create a PIT with partial failures. Optional. Default is true.

API name: allow_partial_pit_creation