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

Class CreatePitRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<CreatePitRequest>

Enclosing class:

CreatePitRequest

public static class CreatePitRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<CreatePitRequest>

Builder for CreatePitRequest

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

targetIndexes

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

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

Adds all elements of list to targetIndexes.

targetIndexes

public final CreatePitRequest.Builder targetIndexes(java.lang.String value,
                                                    java.lang.String... values)

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

Adds one or more values to targetIndexes.

keepAlive

public final CreatePitRequest.Builder keepAlive(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

keepAlive

public final CreatePitRequest.Builder keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

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

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

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

API name: preference

routing

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

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

API name: routing

expandWildcards

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

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

Adds all elements of list to expandWildcards.

expandWildcards

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

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

Adds one or more values to expandWildcards.

allowPartialPitCreation

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

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

API name: allow_partial_pit_creation

build

public CreatePitRequest build()

Builds a CreatePitRequest.

Specified by:

build in interface ObjectBuilder<CreatePitRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.