Package co.elastic.clients.elasticsearch.indices

Class GetDataStreamRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.GetDataStreamRequest.Builder

All Implemented Interfaces:

WithJson<GetDataStreamRequest.Builder>, ObjectBuilder<GetDataStreamRequest>

Enclosing class:

GetDataStreamRequest

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

Builder for GetDataStreamRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetDataStreamRequest	build()	Builds a GetDataStreamRequest.
final GetDataStreamRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of data stream that wildcard patterns can match.
final GetDataStreamRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of data stream that wildcard patterns can match.
final GetDataStreamRequest.Builder	includeDefaults(Boolean value)	If true, returns all relevant default configurations for the index template.
final GetDataStreamRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetDataStreamRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final GetDataStreamRequest.Builder	name(String value, String... values)	Comma-separated list of data stream names used to limit the request.
final GetDataStreamRequest.Builder	name(List<String> list)	Comma-separated list of data stream names used to limit the request.
protected GetDataStreamRequest.Builder	self()
final GetDataStreamRequest.Builder	verbose(Boolean value)	Whether the maximum timestamp for each data stream should be calculated and returned.

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 GetDataStreamRequest.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 GetDataStreamRequest.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.

includeDefaults

public final GetDataStreamRequest.Builder includeDefaults(@Nullable
 Boolean value)

If true, returns all relevant default configurations for the index template.

API name: include_defaults

masterTimeout

public final GetDataStreamRequest.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 GetDataStreamRequest.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 GetDataStreamRequest.Builder name(List<String> list)

Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

API name: name

Adds all elements of list to name.

name

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

Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

API name: name

Adds one or more values to name.

verbose

public final GetDataStreamRequest.Builder verbose(@Nullable
 Boolean value)

Whether the maximum timestamp for each data stream should be calculated and returned.

API name: verbose

self

protected GetDataStreamRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetDataStreamRequest.Builder>

build

public GetDataStreamRequest build()

Builds a GetDataStreamRequest.

Specified by:

build in interface ObjectBuilder<GetDataStreamRequest>

Throws:

NullPointerException - if some of the required fields are null.