Package org.opensearch.client.opensearch.indices

Class IndexSettingBlocks

java.lang.Object

org.opensearch.client.opensearch.indices.IndexSettingBlocks

All Implemented Interfaces:

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

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

The block settings that control index operations.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static IndexSettingBlocks.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	metadata()	API name: metadata
static IndexSettingBlocks	of(Function<IndexSettingBlocks.Builder,ObjectBuilder<IndexSettingBlocks>> fn)
final Boolean	read()	API name: read
final Boolean	readOnly()	API name: read_only
final Boolean	readOnlyAllowDelete()	API name: read_only_allow_delete
final Boolean	searchOnly()	When true, the index is in search-only mode, allowing only read operations
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	setupIndexSettingBlocksDeserializer(ObjectDeserializer<IndexSettingBlocks.Builder> op)
IndexSettingBlocks.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	write()	API name: write

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<IndexSettingBlocks> _DESERIALIZER

Json deserializer for IndexSettingBlocks

Method Details

of

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

metadata

@Nullable
public final Boolean metadata()

API name: metadata

read

@Nullable
public final Boolean read()

API name: read

readOnly

@Nullable
public final Boolean readOnly()

API name: read_only

readOnlyAllowDelete

@Nullable
public final Boolean readOnlyAllowDelete()

API name: read_only_allow_delete

searchOnly

@Nullable
public final Boolean searchOnly()

When true, the index is in search-only mode, allowing only read operations

API name: search_only

write

@Nullable
public final Boolean write()

API name: write

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

Returns:

a new builder instance.

builder

@Nonnull
public static IndexSettingBlocks.Builder builder()

setupIndexSettingBlocksDeserializer

protected static void setupIndexSettingBlocksDeserializer(ObjectDeserializer<IndexSettingBlocks.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object