Package org.elasticsearch.client.ml
Class GetCategoriesRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.client.ml.GetCategoriesRequest
-
- All Implemented Interfaces:
Streamable
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class GetCategoriesRequest extends ActionRequest implements ToXContentObject
A request to retrieve categories 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
CATEGORY_ID
static ConstructingObjectParser<GetCategoriesRequest,java.lang.Void>
PARSER
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description GetCategoriesRequest(java.lang.String jobId)
Constructs a request to retrieve category information from a given job
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.Long
getCategoryId()
java.lang.String
getJobId()
PageParams
getPageParams()
int
hashCode()
void
setCategoryId(java.lang.Long categoryId)
Sets the category idvoid
setPageParams(PageParams pageParams)
Sets the paging parametersXContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, 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
-
CATEGORY_ID
public static final ParseField CATEGORY_ID
-
PARSER
public static final ConstructingObjectParser<GetCategoriesRequest,java.lang.Void> PARSER
-
-
Method Detail
-
getJobId
public java.lang.String getJobId()
-
getPageParams
public PageParams getPageParams()
-
getCategoryId
public java.lang.Long getCategoryId()
-
setCategoryId
public void setCategoryId(java.lang.Long categoryId)
Sets the category id- Parameters:
categoryId
- the category id
-
setPageParams
public void setPageParams(PageParams pageParams)
Sets the paging parameters- Parameters:
pageParams
- the paging parameters
-
validate
public ActionRequestValidationException 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
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-