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, 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>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	CATEGORY_ID
static ConstructingObjectParser<GetCategoriesRequest,Void>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetCategoriesRequest(String jobId)	Constructs a request to retrieve category information from a given job

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Long	getCategoryId()
String	getJobId()
PageParams	getPageParams()
int	hashCode()
void	setCategoryId(Long categoryId)	Sets the category id
void	setPageParams(PageParams pageParams)	Sets the paging parameters
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, 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,Void> PARSER

Constructor Detail

GetCategoriesRequest

public GetCategoriesRequest(String jobId)

Constructs a request to retrieve category information from a given job

Parameters:

jobId - id of the job from which to retrieve results

Method Detail

getJobId

public String getJobId()

getPageParams

public PageParams getPageParams()

getCategoryId

public Long getCategoryId()

setCategoryId

public void setCategoryId(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 class ActionRequest

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object