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, ToXContent, ToXContentObject, TaskAwareRequest

public class GetModelSnapshotsRequest
extends ActionRequest
implements 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.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 ParseField	DESC
static ParseField	END
static ConstructingObjectParser<GetModelSnapshotsRequest,Void>	PARSER
static ParseField	SNAPSHOT_ID
static ParseField	SORT
static ParseField	START

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetModelSnapshotsRequest(String jobId)	Constructs a request to retrieve snapshot information from a given job

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Boolean	getDesc()
String	getEnd()
String	getJobId()
PageParams	getPageParams()
String	getSnapshotId()
String	getSort()
String	getStart()
int	hashCode()
void	setDesc(boolean desc)	Sets the value of "desc".
void	setEnd(String end)	Sets the value of "end" which is a timestamp.
void	setPageParams(PageParams pageParams)	Sets the paging parameters
void	setSnapshotId(String snapshotId)	Sets the id of the snapshot to retrieve.
void	setSort(String sort)	Sets the value of "sort".
void	setStart(String start)	Sets the value of "start" which is a timestamp.
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, getDescription, setParentTask

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

isFragment

Field Detail

SNAPSHOT_ID

public static final ParseField SNAPSHOT_ID

SORT

public static final ParseField SORT

START

public static final ParseField START

END

public static final ParseField END

DESC

public static final ParseField DESC

PARSER

public static final ConstructingObjectParser<GetModelSnapshotsRequest,Void> PARSER

Constructor Detail

GetModelSnapshotsRequest

public GetModelSnapshotsRequest(String jobId)

Constructs a request to retrieve snapshot information from a given job

Parameters:

jobId - id of the job from which to retrieve results

Method Detail

getJobId

public String getJobId()

getSnapshotId

public String getSnapshotId()

setSnapshotId

public void setSnapshotId(String snapshotId)

Sets the id of the snapshot to retrieve.

Parameters:

snapshotId - the snapshot id

getSort

public String getSort()

setSort

public void setSort(String sort)

Sets the value of "sort". Specifies the snapshot field to sort on.

Parameters:

sort - value of "sort".

getPageParams

public PageParams getPageParams()

setPageParams

public void setPageParams(PageParams pageParams)

Sets the paging parameters

Parameters:

pageParams - the paging parameters

getStart

public String getStart()

setStart

public void setStart(String start)

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

public String getEnd()

setEnd

public void setEnd(String end)

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

public Boolean getDesc()

setDesc

public void setDesc(boolean desc)

Sets the value of "desc". Specifies the sorting order.

Parameters:

desc - value of "desc"

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