Package org.opensearch.client.opensearch.core

Class CreatePitRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.CreatePitRequest

All Implemented Interfaces:

ToCopyableBuilder<CreatePitRequest.Builder,CreatePitRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CreatePitRequest
extends RequestBase
implements ToCopyableBuilder<CreatePitRequest.Builder,CreatePitRequest>

Creates point in time context.

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 final Endpoint<CreatePitRequest,CreatePitResponse,ErrorResponse>	_ENDPOINT	Endpoint "create_pit".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowPartialPitCreation()	Allow if point in time can be created with partial failures.
protected void	applyQueryParameters(Map<String,String> params)
static CreatePitRequest.Builder	builder()
boolean	equals(Object o)
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
int	hashCode()
final List<String>	index()	Required - Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
final Time	keepAlive()	Specify the keep alive for point in time.
static CreatePitRequest	of(Function<CreatePitRequest.Builder,ObjectBuilder<CreatePitRequest>> fn)
final String	preference()	Specify the node or shard the operation should be performed on.
final List<String>	routing()	Comma-separated list of specific routing values.
CreatePitRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

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

Endpoint "create_pit".

Method Details

of

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

allowPartialPitCreation

@Nullable
public final Boolean allowPartialPitCreation()

Allow if point in time can be created with partial failures.

API name: allow_partial_pit_creation

expandWildcards

@Nonnull
public final List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indexes that are open, closed or both.

API name: expand_wildcards

index

@Nonnull
public final List<String> index()

Required - Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.

API name: index

keepAlive

@Nullable
public final Time keepAlive()

Specify the keep alive for point in time.

API name: keep_alive

preference

@Nullable
public final String preference()

Specify the node or shard the operation should be performed on.

API name: preference

routing

@Nonnull
public final List<String> routing()

Comma-separated list of specific routing values.

API name: routing

toBuilder

@Nonnull
public CreatePitRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePitRequest.Builder,CreatePitRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreatePitRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object