Package org.elasticsearch.client.ml

Class UpdateModelSnapshotRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.UpdateModelSnapshotRequest

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class UpdateModelSnapshotRequest
extends ActionRequest
implements ToXContentObject

A request to update information about an existing model snapshot for a given job

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ConstructingObjectParser<UpdateModelSnapshotRequest,Void>	PARSER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UpdateModelSnapshotRequest(String jobId, String snapshotId)	Constructs a request to update information for a snapshot of given job

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Returns optional description of the request to be displayed by the task manager
String	getJobId()
Boolean	getRetain()
String	getSnapshotId()
int	hashCode()
void	setDescription(String description)	The new description of the snapshot.
void	setRetain(boolean retain)	The new value of the "retain" property of the snapshot
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

PARSER

public static final ConstructingObjectParser<UpdateModelSnapshotRequest,Void> PARSER

Constructor Detail

UpdateModelSnapshotRequest

public UpdateModelSnapshotRequest(String jobId,
                                  String snapshotId)

Constructs a request to update information for a snapshot of given job

Parameters:

jobId - id of the job from which to retrieve results

snapshotId - id of the snapshot from which to retrieve results

Method Detail

getJobId

public String getJobId()

getSnapshotId

public String getSnapshotId()

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest

setDescription

public void setDescription(String description)

The new description of the snapshot.

Parameters:

description - the updated snapshot description

getRetain

public Boolean getRetain()

setRetain

public void setRetain(boolean retain)

The new value of the "retain" property of the snapshot

Parameters:

retain - the updated retain property

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object