Package org.opensearch.client.opensearch.indices

Class IndexSettingBlocks.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexSettingBlocks.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexSettingBlocks

public static class IndexSettingBlocks.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IndexSettingBlocks.Builder,IndexSettingBlocks>

Builder for IndexSettingBlocks.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexSettingBlocks	build()	Builds a IndexSettingBlocks.
IndexSettingBlocks.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexSettingBlocks.Builder	metadata(Boolean value)	API name: metadata
final IndexSettingBlocks.Builder	read(Boolean value)	API name: read
final IndexSettingBlocks.Builder	readOnly(Boolean value)	API name: read_only
final IndexSettingBlocks.Builder	readOnlyAllowDelete(Boolean value)	API name: read_only_allow_delete
final IndexSettingBlocks.Builder	searchOnly(Boolean value)	When true, the index is in search-only mode, allowing only read operations
final IndexSettingBlocks.Builder	write(Boolean value)	API name: write

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

Returns:

a new builder instance.

metadata

@Nonnull
public final IndexSettingBlocks.Builder metadata(@Nullable
 Boolean value)

API name: metadata

read

@Nonnull
public final IndexSettingBlocks.Builder read(@Nullable
 Boolean value)

API name: read

readOnly

@Nonnull
public final IndexSettingBlocks.Builder readOnly(@Nullable
 Boolean value)

API name: read_only

readOnlyAllowDelete

@Nonnull
public final IndexSettingBlocks.Builder readOnlyAllowDelete(@Nullable
 Boolean value)

API name: read_only_allow_delete

searchOnly

@Nonnull
public final IndexSettingBlocks.Builder searchOnly(@Nullable
 Boolean value)

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

API name: search_only

write

@Nonnull
public final IndexSettingBlocks.Builder write(@Nullable
 Boolean value)

API name: write

build

@Nonnull
public IndexSettingBlocks build()

Builds a IndexSettingBlocks.

Specified by:

build in interface ObjectBuilder<IndexSettingBlocks>

Throws:

NullPointerException - if some of the required fields are null.