Package org.opensearch.action.admin.indices.readonly

Class AddIndexBlockRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<Request,Response>

org.opensearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>

org.opensearch.action.support.master.AcknowledgedRequestBuilder<AddIndexBlockRequest,AddIndexBlockResponse,AddIndexBlockRequestBuilder>

org.opensearch.action.admin.indices.readonly.AddIndexBlockRequestBuilder

public class AddIndexBlockRequestBuilder
extends AcknowledgedRequestBuilder<AddIndexBlockRequest,AddIndexBlockResponse,AddIndexBlockRequestBuilder>

Builder for add index block request

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
AddIndexBlockRequestBuilder(OpenSearchClient client, AddIndexBlockAction action, IndexMetadata.APIBlock block, java.lang.String... indices)

Method Summary

Modifier and Type	Method	Description
AddIndexBlockRequestBuilder	setIndices(java.lang.String... indices)	Sets the indices to be blocked
AddIndexBlockRequestBuilder	setIndicesOptions(IndicesOptions indicesOptions)	Specifies what type of requested indices to ignore and wildcard indices expressions For example indices that don't exist.

Methods inherited from class org.opensearch.action.support.master.AcknowledgedRequestBuilder

setTimeout, setTimeout

Methods inherited from class org.opensearch.action.support.master.MasterNodeOperationRequestBuilder

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

AddIndexBlockRequestBuilder

public AddIndexBlockRequestBuilder(OpenSearchClient client, AddIndexBlockAction action, IndexMetadata.APIBlock block, java.lang.String... indices)

Method Details

setIndices

public AddIndexBlockRequestBuilder setIndices(java.lang.String... indices)

Sets the indices to be blocked

Parameters:

indices - the indices to be blocked

Returns:

the request itself

setIndicesOptions

public AddIndexBlockRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)

Specifies what type of requested indices to ignore and wildcard indices expressions For example indices that don't exist.

Parameters:

indicesOptions - the desired behaviour regarding indices to ignore and indices wildcard expressions

Returns:

the request itself