SetUpgradeModeRequest (rest-high-level 7.8.0 API)

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.SetUpgradeModeRequest

All Implemented Interfaces:: Writeable, TaskAwareRequest

public class SetUpgradeModeRequest
extends ActionRequest

Sets ML into upgrade_mode

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
Field Summary

Fields

Modifier and Type Field Description

static ParseField ENABLED

static ParseField TIMEOUT
Constructor Summary

Constructors

Constructor Description

SetUpgradeModeRequest(boolean enabled)
Create a new request

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object other)`
`TimeValue`	`getTimeout()`
`int`	`hashCode()`
`boolean`	`isEnabled()`
`void`	`setEnabled(boolean enabled)`
`void`	`setTimeout(TimeValue timeout)`	How long to wait for the request to be completed
`ActionRequestValidationException`	`validate()`

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, writeTo

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details
- ENABLED
  
  public static final ParseField ENABLED
- TIMEOUT
  
  public static final ParseField TIMEOUT
Constructor Details
- SetUpgradeModeRequest
  
  public SetUpgradeModeRequest(boolean enabled)
  
  Create a new request
  
  Parameters:
  
  enabled - whether to enable `upgrade_mode` or not
Method Details
- isEnabled
  
  public boolean isEnabled()
- setEnabled
  
  public void setEnabled(boolean enabled)
- getTimeout
  
  public TimeValue getTimeout()
- setTimeout
  
  public void setTimeout(TimeValue timeout)
  
  How long to wait for the request to be completed
  
  Parameters:
  
  timeout - default value of 30 seconds
- validate
  
  public ActionRequestValidationException validate()
  
  Specified by:
  
  validate in class ActionRequest
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- equals
  
  public boolean equals(java.lang.Object other)
  
  Overrides:
  
  equals in class java.lang.Object