Package org.opensearch.client.opensearch.indices

Class IndexTemplateDataStreamConfiguration

java.lang.Object

org.opensearch.client.opensearch.indices.IndexTemplateDataStreamConfiguration

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<IndexTemplateDataStreamConfiguration.Builder,IndexTemplateDataStreamConfiguration>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class IndexTemplateDataStreamConfiguration
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<IndexTemplateDataStreamConfiguration.Builder,IndexTemplateDataStreamConfiguration>

The data stream configuration for an index template.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<IndexTemplateDataStreamConfiguration>	_DESERIALIZER	Json deserializer for IndexTemplateDataStreamConfiguration

Method Summary

Modifier and Type	Method	Description
final Boolean	allowCustomRouting()	When true, the data stream supports custom routing.
static IndexTemplateDataStreamConfiguration.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	hidden()	When true, the data stream is hidden.
static IndexTemplateDataStreamConfiguration	of(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupIndexTemplateDataStreamConfigurationDeserializer(ObjectDeserializer<IndexTemplateDataStreamConfiguration.Builder> op)
final DataStreamTimestampField	timestampField()	API name: timestamp_field
IndexTemplateDataStreamConfiguration.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<IndexTemplateDataStreamConfiguration> _DESERIALIZER

Json deserializer for IndexTemplateDataStreamConfiguration

Method Details

of

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

allowCustomRouting

@Nullable
public final Boolean allowCustomRouting()

When true, the data stream supports custom routing.

API name: allow_custom_routing

hidden

@Nullable
public final Boolean hidden()

When true, the data stream is hidden.

API name: hidden

timestampField

@Nullable
public final DataStreamTimestampField timestampField()

API name: timestamp_field

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static IndexTemplateDataStreamConfiguration.Builder builder()

setupIndexTemplateDataStreamConfigurationDeserializer

protected static void setupIndexTemplateDataStreamConfigurationDeserializer(ObjectDeserializer<IndexTemplateDataStreamConfiguration.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object