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:
Streamable
,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 extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Field Summary
Fields Modifier and Type Field Description static ConstructingObjectParser<UpdateModelSnapshotRequest,java.lang.Void>
PARSER
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description UpdateModelSnapshotRequest(java.lang.String jobId, java.lang.String snapshotId)
Constructs a request to update information for a snapshot of given job
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getDescription()
java.lang.String
getJobId()
java.lang.Boolean
getRetain()
java.lang.String
getSnapshotId()
int
hashCode()
void
setDescription(java.lang.String description)
The new description of the snapshot.void
setRetain(boolean retain)
The new value of the "retain" property of the snapshotXContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, 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,java.lang.Void> PARSER
-
-
Constructor Detail
-
UpdateModelSnapshotRequest
public UpdateModelSnapshotRequest(java.lang.String jobId, java.lang.String snapshotId)
Constructs a request to update information for a snapshot of given job- Parameters:
jobId
- id of the job from which to retrieve resultssnapshotId
- id of the snapshot from which to retrieve results
-
-
Method Detail
-
getJobId
public java.lang.String getJobId()
-
getSnapshotId
public java.lang.String getSnapshotId()
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescription
in interfaceTaskAwareRequest
-
setDescription
public void setDescription(java.lang.String description)
The new description of the snapshot.- Parameters:
description
- the updated snapshot description
-
getRetain
public java.lang.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 classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-