CloseIndexRequest

java.lang.Object
- org.elasticsearch.common.ContextAndHeaderHolder
- - org.elasticsearch.transport.TransportMessage<TransportRequest>
  - - org.elasticsearch.transport.TransportRequest
    - - org.elasticsearch.action.ActionRequest<T>
      - org.elasticsearch.action.support.master.MasterNodeOperationRequest<T>
        
        org.elasticsearch.action.support.master.AcknowledgedRequest<CloseIndexRequest>
        
        org.elasticsearch.action.admin.indices.close.CloseIndexRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, AckedRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class CloseIndexRequest
extends AcknowledgedRequest<CloseIndexRequest>
implements IndicesRequest.Replaceable
```
A request to close an index.

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable

Field Summary
- Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest
  DEFAULT_ACK_TIMEOUT, timeout
- Fields inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequest
  DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
- Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder
  headers

Constructor Summary

Constructors

Constructor and Description
`CloseIndexRequest(String... indices)` Constructs a new close index request for the specified index.

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`String[]`	`indices()` The indices to be closed
`CloseIndexRequest`	`indices(String... indices)` Sets the indices to be closed
`IndicesOptions`	`indicesOptions()` Specifies what type of requested indices to ignore and how to deal with wildcard expressions.
`CloseIndexRequest`	`indicesOptions(IndicesOptions indicesOptions)` Specifies what type of requested indices to ignore and how to deal wild wildcard expressions.
`void`	`readFrom(StreamInput in)`
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)`

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest
ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest
listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage
putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest
masterNodeTimeout

- Constructor Detail
  - CloseIndexRequest
```
public CloseIndexRequest(String... indices)
```
    Constructs a new close index request for the specified index.
- Method Detail
  - validate
```
public ActionRequestValidationException validate()
```
  - indices
```
public String[] indices()
```
    The indices to be closed
    
    Specified by:
    
    indices in interface IndicesRequest
    
    Returns:
    
    the indices to be closed
  - indices
```
public CloseIndexRequest indices(String... indices)
```
    Sets the indices to be closed
    
    Specified by:
    
    indices in interface IndicesRequest.Replaceable
    
    Parameters:
    
    indices - the indices to be closed
    
    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 CloseIndexRequest 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
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    Specified by:
    
    readFrom in interface Streamable
    
    Overrides:
    
    readFrom in class MasterNodeOperationRequest<CloseIndexRequest>
    
    Throws:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Specified by:
    
    writeTo in interface Streamable
    
    Overrides:
    
    writeTo in class MasterNodeOperationRequest<CloseIndexRequest>
    
    Throws:
    
    IOException

Class CloseIndexRequest

Nested Class Summary

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

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

Field Summary

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

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequest

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Constructor Summary

Constructors

Method Summary

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

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequest

Methods inherited from class org.elasticsearch.action.ActionRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseIndexRequest

Method Detail

validate

indices

indices

indicesOptions

indicesOptions

readFrom

writeTo