Package org.elasticsearch.client.ml
Class GetInfluencersRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetInfluencersRequest
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class GetInfluencersRequest extends ActionRequest implements ToXContentObject
A request to retrieve influencers of 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 ParseField
DESCENDING
static ParseField
END
static ParseField
EXCLUDE_INTERIM
static ParseField
INFLUENCER_SCORE
static ConstructingObjectParser<GetInfluencersRequest,java.lang.Void>
PARSER
static ParseField
SORT
static ParseField
START
-
Constructor Summary
Constructors Constructor Description GetInfluencersRequest(java.lang.String jobId)
Constructs a request to retrieve influencers 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.Double
getInfluencerScore()
java.lang.String
getJobId()
PageParams
getPageParams()
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
setInfluencerScore(java.lang.Double influencerScore)
Sets the value of "influencer_score".void
setPageParams(PageParams pageParams)
Sets the paging parametersvoid
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)
ActionRequestValidationException
validate()
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
-
Field Details
-
Constructor Details
-
GetInfluencersRequest
public GetInfluencersRequest(java.lang.String jobId)Constructs a request to retrieve influencers of a given job- Parameters:
jobId
- id of the job to retrieve influencers of
-
-
Method Details
-
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". Whentrue
, interim influencers 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 influencers 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 influencers 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
-
getInfluencerScore
public java.lang.Double getInfluencerScore() -
setInfluencerScore
public void setInfluencerScore(java.lang.Double influencerScore)Sets the value of "influencer_score". Only influencers with "influencer_score" equal or greater will be returned.- Parameters:
influencerScore
- value of "influencer_score".
-
getSort
public java.lang.String getSort() -
setSort
public void setSort(java.lang.String sort)Sets the value of "sort". Specifies the influencer 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"
-
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
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-