Package org.elasticsearch.client.ml
Class GetRecordsRequest
java.lang.Object
org.elasticsearch.client.ml.GetRecordsRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class GetRecordsRequest
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Validatable
A request to retrieve records of a given job
-
Nested Class Summary
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ObjectParser<GetRecordsRequest,
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
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionGetRecordsRequest
(String jobId) Constructs a request to retrieve records of a given job -
Method Summary
Modifier and TypeMethodDescriptionboolean
getEnd()
getJobId()
getSort()
getStart()
int
hashCode()
void
setDescending
(Boolean descending) Sets the value of "desc".void
Sets the value of "end" which is a timestamp.void
setExcludeInterim
(Boolean excludeInterim) Sets the value of "exclude_interim".void
setPageParams
(PageParams pageParams) Sets the paging parametersvoid
setRecordScore
(Double recordScore) Sets the value of "record_score".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) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Field Details
-
EXCLUDE_INTERIM
public static final org.elasticsearch.xcontent.ParseField EXCLUDE_INTERIM -
START
public static final org.elasticsearch.xcontent.ParseField START -
END
public static final org.elasticsearch.xcontent.ParseField END -
RECORD_SCORE
public static final org.elasticsearch.xcontent.ParseField RECORD_SCORE -
SORT
public static final org.elasticsearch.xcontent.ParseField SORT -
DESCENDING
public static final org.elasticsearch.xcontent.ParseField DESCENDING -
PARSER
-
-
Constructor Details
-
GetRecordsRequest
Constructs a request to retrieve records of a given job- Parameters:
jobId
- id of the job to retrieve records of
-
-
Method Details
-
getJobId
-
getExcludeInterim
-
setExcludeInterim
Sets the value of "exclude_interim". Whentrue
, interim records will be filtered out.- Parameters:
excludeInterim
- value of "exclude_interim" to be set
-
getStart
-
setStart
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
-
setEnd
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
-
setPageParams
Sets the paging parameters- Parameters:
pageParams
- The paging parameters
-
getRecordScore
-
setRecordScore
Sets the value of "record_score". Only records with "record_score" equal or greater will be returned.- Parameters:
recordScore
- value of "record_score".
-
getSort
-
setSort
Sets the value of "sort". Specifies the record field to sort on.- Parameters:
sort
- value of "sort".
-
getDescending
-
setDescending
Sets the value of "desc". Specifies the sorting order.- Parameters:
descending
- value of "desc"
-
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
-
hashCode
public int hashCode() -
equals
-