Package org.opensearch.client.opensearch.indices

Class GetDataStreamRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetDataStreamRequest

All Implemented Interfaces:

ToCopyableBuilder<GetDataStreamRequest.Builder,GetDataStreamRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetDataStreamRequest
extends RequestBase
implements ToCopyableBuilder<GetDataStreamRequest.Builder,GetDataStreamRequest>

Returns data streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDataStreamRequest.Builder	Builder for GetDataStreamRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetDataStreamRequest,GetDataStreamResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_data_stream".

Method Summary

Modifier and Type	Method	Description
static GetDataStreamRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	name()	Comma-separated list of data stream names used to limit the request.
static GetDataStreamRequest	of(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)
GetDataStreamRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetDataStreamRequest,GetDataStreamResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_data_stream".

Method Details

of

public static GetDataStreamRequest of(Function<GetDataStreamRequest.Builder,ObjectBuilder<GetDataStreamRequest>> fn)

name

@Nonnull
public final List<String> name()

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

toBuilder

@Nonnull
public GetDataStreamRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetDataStreamRequest.Builder,GetDataStreamRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetDataStreamRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object