Package org.opensearch.client.opensearch.indices

Class GetDataStreamRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.indices.GetDataStreamRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetDataStreamRequest

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

Builder for GetDataStreamRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetDataStreamRequest	build()	Builds a GetDataStreamRequest.
GetDataStreamRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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()

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

Returns:

a new builder instance.

self

@Nonnull
protected GetDataStreamRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetDataStreamRequest.Builder>

name

@Nonnull
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

@Nonnull
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.

build

@Nonnull
public GetDataStreamRequest build()

Builds a GetDataStreamRequest.

Specified by:

build in interface ObjectBuilder<GetDataStreamRequest>

Throws:

NullPointerException - if some of the required fields are null.