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:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class GetCategoriesRequest
extends ActionRequest
implements org.elasticsearch.xcontent.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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<GetCategoriesRequest,
Void> static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionGetCategoriesRequest
(String jobId) Constructs a request to retrieve category information from a given job -
Method Summary
Modifier and TypeMethodDescriptionboolean
getJobId()
int
hashCode()
void
setCategoryId
(Long categoryId) Sets the category idvoid
setPageParams
(PageParams pageParams) Sets the paging parametersvoid
setPartitionFieldValue
(String partitionFieldValue) Sets the partition field valueorg.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validate()
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, writeTo
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
CATEGORY_ID
public static final org.elasticsearch.xcontent.ParseField CATEGORY_ID -
PARTITION_FIELD_VALUE
public static final org.elasticsearch.xcontent.ParseField PARTITION_FIELD_VALUE -
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetCategoriesRequest,Void> PARSER
-
-
Constructor Details
-
GetCategoriesRequest
Constructs a request to retrieve category information from a given job- Parameters:
jobId
- id of the job from which to retrieve results
-
-
Method Details
-
getJobId
-
getPageParams
-
getCategoryId
-
setCategoryId
Sets the category id- Parameters:
categoryId
- the category id
-
setPageParams
Sets the paging parameters- Parameters:
pageParams
- the paging parameters
-
getPartitionFieldValue
-
setPartitionFieldValue
Sets the partition field value- Parameters:
partitionFieldValue
- the partition field value
-
validate
- Specified by:
validate
in classActionRequest
-
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
-
equals
-
hashCode
public int hashCode()
-