SearchScrollRequest

java.lang.Object
- org.elasticsearch.common.ContextAndHeaderHolder
- - org.elasticsearch.transport.TransportMessage<TransportRequest>
  - - org.elasticsearch.transport.TransportRequest
    - - org.elasticsearch.action.ActionRequest<SearchScrollRequest>
      - org.elasticsearch.action.search.SearchScrollRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class SearchScrollRequest
extends ActionRequest<SearchScrollRequest>
```

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

Field Summary
- Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder
  headers

Constructor Summary

Constructors

Constructor and Description
`SearchScrollRequest()`
`SearchScrollRequest(String scrollId)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`void`	`readFrom(StreamInput in)`
`Scroll`	`scroll()` If set, will enable scrolling of the search request.
`SearchScrollRequest`	`scroll(Scroll scroll)` If set, will enable scrolling of the search request.
`SearchScrollRequest`	`scroll(String keepAlive)` If set, will enable scrolling of the search request for the specified timeout.
`SearchScrollRequest`	`scroll(TimeValue keepAlive)` If set, will enable scrolling of the search request for the specified timeout.
`String`	`scrollId()` The scroll id used to scroll the search.
`SearchScrollRequest`	`scrollId(String scrollId)`
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)`

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

- Constructor Detail
  - SearchScrollRequest
```
public SearchScrollRequest()
```
  - SearchScrollRequest
```
public SearchScrollRequest(String scrollId)
```
- Method Detail
  - validate
```
public ActionRequestValidationException validate()
```
  - scrollId
```
public String scrollId()
```
    The scroll id used to scroll the search.
  - scrollId
```
public SearchScrollRequest scrollId(String scrollId)
```
  - scroll
```
public Scroll scroll()
```
    If set, will enable scrolling of the search request.
  - scroll
```
public SearchScrollRequest scroll(Scroll scroll)
```
    If set, will enable scrolling of the search request.
  - scroll
```
public SearchScrollRequest scroll(TimeValue keepAlive)
```
    If set, will enable scrolling of the search request for the specified timeout.
  - scroll
```
public SearchScrollRequest scroll(String keepAlive)
```
    If set, will enable scrolling of the search request for the specified timeout.
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    Specified by:
    
    readFrom in interface Streamable
    
    Overrides:
    
    readFrom in class ActionRequest<SearchScrollRequest>
    
    Throws:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Specified by:
    
    writeTo in interface Streamable
    
    Overrides:
    
    writeTo in class ActionRequest<SearchScrollRequest>
    
    Throws:
    
    IOException

Class SearchScrollRequest

Nested Class Summary

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

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Constructor Summary

Constructors

Method Summary

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

Constructor Detail

SearchScrollRequest

SearchScrollRequest

Method Detail

validate

scrollId

scrollId

scroll

scroll

scroll

scroll

readFrom

writeTo