UpgradeRequest (server 7.5.2 API)

java.lang.Object
- org.elasticsearch.transport.TransportMessage
- - org.elasticsearch.transport.TransportRequest
  - - org.elasticsearch.action.ActionRequest
    - - org.elasticsearch.action.support.broadcast.BroadcastRequest<UpgradeRequest>
      - org.elasticsearch.action.admin.indices.upgrade.post.UpgradeRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, TaskAwareRequest
```
public class UpgradeRequest
extends BroadcastRequest<UpgradeRequest>
```
A request to upgrade one or more indices. In order to update all indices, pass an empty array or null for the indices.

See Also:

Requests.upgradeRequest(String...), IndicesAdminClient.upgrade(UpgradeRequest), UpgradeResponse

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UpgradeRequest.Defaults
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary
- Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
  indices

Constructor Summary

Constructors
Constructor Description

UpgradeRequest(java.lang.String... indices)
Constructs an optimization request over one or more indices.

UpgradeRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`toString()`
`boolean`	`upgradeOnlyAncientSegments()`	Should the upgrade only the ancient (older major version of Lucene) segments? Defaults to `false`.
`UpgradeRequest`	`upgradeOnlyAncientSegments(boolean upgradeOnlyAncientSegments)`	See `upgradeOnlyAncientSegments()`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest
indices, indices, indicesOptions, indicesOptions, validate

Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask

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

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask

- Constructor Detail
  - UpgradeRequest
```
public UpgradeRequest(java.lang.String... indices)
```
    Constructs an optimization request over one or more indices.
    
    Parameters:
    
    indices - The indices to upgrade, no indices passed means all indices will be optimized.
  - UpgradeRequest
```
public UpgradeRequest(StreamInput in)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - writeTo
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
    Description copied from interface: Writeable
    
    Write this into the StreamOutput.
    
    Specified by:
    
    writeTo in interface Writeable
    
    Overrides:
    
    writeTo in class BroadcastRequest<UpgradeRequest>
    
    Throws:
    
    java.io.IOException
  - upgradeOnlyAncientSegments
```
public boolean upgradeOnlyAncientSegments()
```
    Should the upgrade only the ancient (older major version of Lucene) segments? Defaults to false.
  - upgradeOnlyAncientSegments
```
public UpgradeRequest upgradeOnlyAncientSegments(boolean upgradeOnlyAncientSegments)
```
    See upgradeOnlyAncientSegments()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object