Package co.elastic.clients.elasticsearch.indices

Class GetDataStreamOptionsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.GetDataStreamOptionsRequest.Builder

All Implemented Interfaces:

WithJson<GetDataStreamOptionsRequest.Builder>, ObjectBuilder<GetDataStreamOptionsRequest>

Enclosing class:

GetDataStreamOptionsRequest

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

Builder for GetDataStreamOptionsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetDataStreamOptionsRequest	build()	Builds a GetDataStreamOptionsRequest.
final GetDataStreamOptionsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of data stream that wildcard patterns can match.
final GetDataStreamOptionsRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of data stream that wildcard patterns can match.
final GetDataStreamOptionsRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetDataStreamOptionsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final GetDataStreamOptionsRequest.Builder	name(String value, String... values)	Required - Comma-separated list of data streams to limit the request.
final GetDataStreamOptionsRequest.Builder	name(List<String> list)	Required - Comma-separated list of data streams to limit the request.
protected GetDataStreamOptionsRequest.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 GetDataStreamOptionsRequest.Builder expandWildcards(List<ExpandWildcard> list)

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

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

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds one or more values to expandWildcards.

masterTimeout

public final GetDataStreamOptionsRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

public final GetDataStreamOptionsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

public final GetDataStreamOptionsRequest.Builder name(List<String> list)

Required - Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

API name: name

Adds all elements of list to name.

name

public final GetDataStreamOptionsRequest.Builder name(String value,
 String... values)

Required - Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

API name: name

Adds one or more values to name.

self

protected GetDataStreamOptionsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetDataStreamOptionsRequest.Builder>

build

public GetDataStreamOptionsRequest build()

Builds a GetDataStreamOptionsRequest.

Specified by:

build in interface ObjectBuilder<GetDataStreamOptionsRequest>

Throws:

NullPointerException - if some of the required fields are null.