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

Class AddIndexBlockRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest<AddIndexBlockRequest>

org.opensearch.action.support.master.MasterNodeRequest<AddIndexBlockRequest>

org.opensearch.action.support.master.AcknowledgedRequest<AddIndexBlockRequest>

org.opensearch.action.admin.indices.readonly.AddIndexBlockRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, AckedRequest, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

@PublicApi(since="1.0.0")
public class AddIndexBlockRequest
extends AcknowledgedRequest<AddIndexBlockRequest>
implements IndicesRequest.Replaceable

A request to add a block to an index.

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, DEFAULT_TASK_EXECUTION_TIMEOUT, timeout

Fields inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
AddIndexBlockRequest(IndexMetadata.APIBlock block, String... indices)	Constructs a new request for the specified block and indices
AddIndexBlockRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
IndexMetadata.APIBlock	getBlock()	Returns the block to be added
String[]	indices()	Returns the indices to be blocked
AddIndexBlockRequest	indices(String... indices)	Sets the indices to be blocked
IndicesOptions	indicesOptions()	Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
AddIndexBlockRequest	indicesOptions(IndicesOptions indicesOptions)	Specifies what type of requested indices to ignore and how to deal wild wildcard expressions.
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

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

ackTimeout, timeout, timeout, timeout

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest

clusterManagerNodeTimeout, clusterManagerNodeTimeout, clusterManagerNodeTimeout, masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.cluster.ack.AckedRequest

clusterManagerNodeTimeout, masterNodeTimeout

Methods inherited from interface org.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

AddIndexBlockRequest

public AddIndexBlockRequest(org.opensearch.core.common.io.stream.StreamInput in)
                     throws IOException

Throws:

IOException

AddIndexBlockRequest

public AddIndexBlockRequest(IndexMetadata.APIBlock block,
 String... indices)

Constructs a new request for the specified block and indices

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public String[] indices()

Returns the indices to be blocked

Specified by:

indices in interface IndicesRequest

indices

public AddIndexBlockRequest indices(String... indices)

Sets the indices to be blocked

Specified by:

indices in interface IndicesRequest.Replaceable

Parameters:

indices - the indices to be blocked

Returns:

the request itself

indicesOptions

public IndicesOptions indicesOptions()

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

Specified by:

indicesOptions in interface IndicesRequest

Returns:

the desired behaviour regarding indices to ignore and wildcard indices expressions

indicesOptions

public AddIndexBlockRequest indicesOptions(IndicesOptions indicesOptions)

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

Parameters:

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

Returns:

the request itself

getBlock

public IndexMetadata.APIBlock getBlock()

Returns the block to be added

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class AcknowledgedRequest<AddIndexBlockRequest>

Throws:

IOException