Package org.opensearch.client.opensearch.core

Class CreatePitRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CreatePitRequest.Builder>

org.opensearch.client.opensearch.core.CreatePitRequest.Builder

All Implemented Interfaces:

CopyableBuilder<CreatePitRequest.Builder,CreatePitRequest>, MutableBuilder<CreatePitRequest.Builder,CreatePitRequest>, ObjectBuilder<CreatePitRequest>

Enclosing class:

CreatePitRequest

public static class CreatePitRequest.Builder
extends RequestBase.AbstractBuilder<CreatePitRequest.Builder>
implements CopyableBuilder<CreatePitRequest.Builder,CreatePitRequest>

Builder for CreatePitRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CreatePitRequest.Builder	allowPartialPitCreation(Boolean value)	Allow if point in time can be created with partial failures.
CreatePitRequest	build()	Builds a CreatePitRequest.
CreatePitRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CreatePitRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final CreatePitRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final CreatePitRequest.Builder	index(String value, String... values)	Required - Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
final CreatePitRequest.Builder	index(List<String> list)	Required - Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.
final CreatePitRequest.Builder	keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify the keep alive for point in time.
final CreatePitRequest.Builder	keepAlive(Time value)	Specify the keep alive for point in time.
final CreatePitRequest.Builder	preference(String value)	Specify the node or shard the operation should be performed on.
final CreatePitRequest.Builder	routing(String value, String... values)	Comma-separated list of specific routing values.
final CreatePitRequest.Builder	routing(List<String> list)	Comma-separated list of specific routing values.
protected CreatePitRequest.Builder	self()

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public CreatePitRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<CreatePitRequest.Builder,CreatePitRequest>

Returns:

a new builder instance.

self

@Nonnull
protected CreatePitRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<CreatePitRequest.Builder>

allowPartialPitCreation

@Nonnull
public final CreatePitRequest.Builder allowPartialPitCreation(@Nullable
 Boolean value)

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

API name: allow_partial_pit_creation

expandWildcards

@Nonnull
public final CreatePitRequest.Builder expandWildcards(List<ExpandWildcard> list)

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

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final CreatePitRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

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

API name: expand_wildcards

Adds one or more values to expandWildcards.

index

@Nonnull
public final CreatePitRequest.Builder index(List<String> list)

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

API name: index

Adds all elements of list to index.

index

@Nonnull
public final CreatePitRequest.Builder index(String value,
 String... values)

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

API name: index

Adds one or more values to index.

keepAlive

@Nonnull
public final CreatePitRequest.Builder keepAlive(@Nullable
 Time value)

Specify the keep alive for point in time.

API name: keep_alive

keepAlive

@Nonnull
public final CreatePitRequest.Builder keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify the keep alive for point in time.

API name: keep_alive

preference

@Nonnull
public final CreatePitRequest.Builder preference(@Nullable
 String value)

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

API name: preference

routing

@Nonnull
public final CreatePitRequest.Builder routing(List<String> list)

Comma-separated list of specific routing values.

API name: routing

Adds all elements of list to routing.

routing

@Nonnull
public final CreatePitRequest.Builder routing(String value,
 String... values)

Comma-separated list of specific routing values.

API name: routing

Adds one or more values to routing.

build

@Nonnull
public CreatePitRequest build()

Builds a CreatePitRequest.

Specified by:

build in interface ObjectBuilder<CreatePitRequest>

Throws:

NullPointerException - if some of the required fields are null.