Package org.opensearch.client.opensearch.indices

Class CreateDataStreamRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.CreateDataStreamRequest

All Implemented Interfaces:

ToCopyableBuilder<CreateDataStreamRequest.Builder,CreateDataStreamRequest>

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

Creates or updates a data stream.

Nested Class Summary

Nested Classes

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

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<CreateDataStreamRequest,CreateDataStreamResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.create_data_stream".

Method Summary

Modifier and Type	Method	Description
static CreateDataStreamRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	name()	Required - Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include \, /, *, ?, ", <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes.
static CreateDataStreamRequest	of(Function<CreateDataStreamRequest.Builder,ObjectBuilder<CreateDataStreamRequest>> fn)
CreateDataStreamRequest.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<CreateDataStreamRequest,CreateDataStreamResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.create_data_stream".

Method Details

of

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

name

@Nonnull
public final String name()

Required - Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include \, /, *, ?, ", <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.

API name: name

toBuilder

@Nonnull
public CreateDataStreamRequest.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<CreateDataStreamRequest.Builder,CreateDataStreamRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateDataStreamRequest.Builder builder()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object