Package org.elasticsearch.client.ml
Class GetModelSnapshotsRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetModelSnapshotsRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class GetModelSnapshotsRequest
extends ActionRequest
implements org.elasticsearch.xcontent.ToXContentObject
A request to retrieve information about model snapshots 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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<GetModelSnapshotsRequest,
Void> static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionGetModelSnapshotsRequest
(String jobId) Constructs a request to retrieve snapshot information from a given job -
Method Summary
Modifier and TypeMethodDescriptionboolean
getDesc()
getEnd()
getJobId()
getSort()
getStart()
int
hashCode()
void
setDesc
(boolean desc) Sets the value of "desc".void
Sets the value of "end" which is a timestamp.void
setPageParams
(PageParams pageParams) Sets the paging parametersvoid
setSnapshotId
(String snapshotId) Sets the id of the snapshot to retrieve.void
Sets the value of "sort".void
Sets the value of "start" which is a timestamp.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
SNAPSHOT_ID
public static final org.elasticsearch.xcontent.ParseField SNAPSHOT_ID -
SORT
public static final org.elasticsearch.xcontent.ParseField SORT -
START
public static final org.elasticsearch.xcontent.ParseField START -
END
public static final org.elasticsearch.xcontent.ParseField END -
DESC
public static final org.elasticsearch.xcontent.ParseField DESC -
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetModelSnapshotsRequest,Void> PARSER
-
-
Constructor Details
-
GetModelSnapshotsRequest
Constructs a request to retrieve snapshot information from a given job- Parameters:
jobId
- id of the job from which to retrieve results
-
-
Method Details
-
getJobId
-
getSnapshotId
-
setSnapshotId
Sets the id of the snapshot to retrieve.- Parameters:
snapshotId
- the snapshot id
-
getSort
-
setSort
Sets the value of "sort". Specifies the snapshot field to sort on.- Parameters:
sort
- value of "sort".
-
getPageParams
-
setPageParams
Sets the paging parameters- Parameters:
pageParams
- the paging parameters
-
getStart
-
setStart
Sets the value of "start" which is a timestamp. Only snapshots whose timestamp is on or after the "start" value will be returned.- Parameters:
start
- String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string
-
getEnd
-
setEnd
Sets the value of "end" which is a timestamp. Only snapshots whose timestamp is before the "end" value will be returned.- Parameters:
end
- String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string
-
getDesc
-
setDesc
public void setDesc(boolean desc) Sets the value of "desc". Specifies the sorting order.- Parameters:
desc
- value of "desc"
-
validate
- Specified by:
validate
in classActionRequest
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-