Package org.elasticsearch.client.ml

Class GetRecordsRequest

java.lang.Object

org.elasticsearch.client.ml.GetRecordsRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class GetRecordsRequest
extends java.lang.Object
implements ToXContentObject, Validatable

A request to retrieve records of a given job

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	DESCENDING
static ParseField	END
static ParseField	EXCLUDE_INTERIM
static ObjectParser<GetRecordsRequest,java.lang.Void>	PARSER
static ParseField	RECORD_SCORE
static ParseField	SORT
static ParseField	START

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

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
GetRecordsRequest(java.lang.String jobId)	Constructs a request to retrieve records of a given job

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getDescending()
java.lang.String	getEnd()
java.lang.Boolean	getExcludeInterim()
java.lang.String	getJobId()
PageParams	getPageParams()
java.lang.Double	getRecordScore()
java.lang.String	getSort()
java.lang.String	getStart()
int	hashCode()
void	setDescending(java.lang.Boolean descending)	Sets the value of "desc".
void	setEnd(java.lang.String end)	Sets the value of "end" which is a timestamp.
void	setExcludeInterim(java.lang.Boolean excludeInterim)	Sets the value of "exclude_interim".
void	setPageParams(PageParams pageParams)	Sets the paging parameters
void	setRecordScore(java.lang.Double recordScore)	Sets the value of "record_score".
void	setSort(java.lang.String sort)	Sets the value of "sort".
void	setStart(java.lang.String start)	Sets the value of "start" which is a timestamp.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Field Detail

EXCLUDE_INTERIM

public static final ParseField EXCLUDE_INTERIM

START

public static final ParseField START

END

public static final ParseField END

RECORD_SCORE

public static final ParseField RECORD_SCORE

SORT

public static final ParseField SORT

DESCENDING

public static final ParseField DESCENDING

PARSER

public static final ObjectParser<GetRecordsRequest,java.lang.Void> PARSER

Constructor Detail

GetRecordsRequest

public GetRecordsRequest(java.lang.String jobId)

Constructs a request to retrieve records of a given job

Parameters:

jobId - id of the job to retrieve records of

Method Detail

getJobId

public java.lang.String getJobId()

getExcludeInterim

public java.lang.Boolean getExcludeInterim()

setExcludeInterim

public void setExcludeInterim(java.lang.Boolean excludeInterim)

Sets the value of "exclude_interim". When true, interim records will be filtered out.

Parameters:

excludeInterim - value of "exclude_interim" to be set

getStart

public java.lang.String getStart()

setStart

public void setStart(java.lang.String start)

Sets the value of "start" which is a timestamp. Only records 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 java.lang.String getEnd()

setEnd

public void setEnd(java.lang.String end)

Sets the value of "end" which is a timestamp. Only records 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

getPageParams

public PageParams getPageParams()

setPageParams

public void setPageParams(PageParams pageParams)

Sets the paging parameters

Parameters:

pageParams - The paging parameters

getRecordScore

public java.lang.Double getRecordScore()

setRecordScore

public void setRecordScore(java.lang.Double recordScore)

Sets the value of "record_score". Only records with "record_score" equal or greater will be returned.

Parameters:

recordScore - value of "record_score".

getSort

public java.lang.String getSort()

setSort

public void setSort(java.lang.String sort)

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

Parameters:

sort - value of "sort".

getDescending

public java.lang.Boolean getDescending()

setDescending

public void setDescending(java.lang.Boolean descending)

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

Parameters:

descending - value of "desc"

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object