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:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class GetCategoriesRequest extends org.elasticsearch.action.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

    org.elasticsearch.transport.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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    CATEGORY_ID
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<GetCategoriesRequest,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    PARTITION_FIELD_VALUE
     

    Fields inherited from interface org.elasticsearch.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()
     
    String
    getPartitionFieldValue()
     
    int
    hashCode()
     
    void
    setCategoryId(Long categoryId)
    Sets the category id
    void
    setPageParams(PageParams pageParams)
    Sets the paging parameters
    void
    setPartitionFieldValue(String partitionFieldValue)
    Sets the partition field value
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    org.elasticsearch.action.ActionRequestValidationException
    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

      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 Details

    • 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

    • getPartitionFieldValue

      public String getPartitionFieldValue()

    • setPartitionFieldValue

      public void setPartitionFieldValue(String partitionFieldValue)
      Sets the partition field value
      Parameters:
      partitionFieldValue - the partition field value

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object