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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)StringgetDescription()Returns optional description of the request to be displayed by the task managerStringgetJobId()BooleangetRetain()StringgetSnapshotId()inthashCode()voidsetDescription(String description)The new description of the snapshot.voidsetRetain(boolean retain)The new value of the "retain" property of the snapshotXContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)ActionRequestValidationExceptionvalidate()-
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
-
-
Method Detail
-
getJobId
public String getJobId()
-
getSnapshotId
public String getSnapshotId()
-
getDescription
public String getDescription()
Description copied from interface:TaskAwareRequestReturns optional description of the request to be displayed by the task manager- Specified by:
getDescriptionin interfaceTaskAwareRequest
-
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:
validatein classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
- Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
-