Package co.elastic.clients.elasticsearch.core

Class OpenPointInTimeRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<OpenPointInTimeRequest.Builder>

co.elastic.clients.elasticsearch.core.OpenPointInTimeRequest.Builder

All Implemented Interfaces:

WithJson<OpenPointInTimeRequest.Builder>, ObjectBuilder<OpenPointInTimeRequest>

Enclosing class:

OpenPointInTimeRequest

public static class OpenPointInTimeRequest.Builder
extends RequestBase.AbstractBuilder<OpenPointInTimeRequest.Builder>
implements ObjectBuilder<OpenPointInTimeRequest>

Builder for OpenPointInTimeRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenPointInTimeRequest	build()	Builds a OpenPointInTimeRequest.
final OpenPointInTimeRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final OpenPointInTimeRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final OpenPointInTimeRequest.Builder	ignoreUnavailable(Boolean value)	If false, the request returns an error if it targets a missing or closed index.
final OpenPointInTimeRequest.Builder	index(String value, String... values)	Required - A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices
final OpenPointInTimeRequest.Builder	index(List<String> list)	Required - A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices
final OpenPointInTimeRequest.Builder	keepAlive(Time value)	Required - Extends the time to live of the corresponding point in time.
final OpenPointInTimeRequest.Builder	keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)	Required - Extends the time to live of the corresponding point in time.
final OpenPointInTimeRequest.Builder	preference(String value)	Specifies the node or shard the operation should be performed on.
final OpenPointInTimeRequest.Builder	routing(String value)	Custom value used to route operations to a specific shard.
protected OpenPointInTimeRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

expandWildcards

public final OpenPointInTimeRequest.Builder expandWildcards(List<ExpandWildcard> list)

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

public final OpenPointInTimeRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

index

public final OpenPointInTimeRequest.Builder index(List<String> list)

Required - A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

public final OpenPointInTimeRequest.Builder index(String value,
 String... values)

Required - A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

keepAlive

public final OpenPointInTimeRequest.Builder keepAlive(Time value)

Required - Extends the time to live of the corresponding point in time.

API name: keep_alive

keepAlive

public final OpenPointInTimeRequest.Builder keepAlive(Function<Time.Builder,ObjectBuilder<Time>> fn)

Required - Extends the time to live of the corresponding point in time.

API name: keep_alive

preference

public final OpenPointInTimeRequest.Builder preference(@Nullable
 String value)

Specifies the node or shard the operation should be performed on. Random by default.

API name: preference

routing

public final OpenPointInTimeRequest.Builder routing(@Nullable
 String value)

Custom value used to route operations to a specific shard.

API name: routing

self

protected OpenPointInTimeRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<OpenPointInTimeRequest.Builder>

build

public OpenPointInTimeRequest build()

Builds a OpenPointInTimeRequest.

Specified by:

build in interface ObjectBuilder<OpenPointInTimeRequest>

Throws:

NullPointerException - if some of the required fields are null.