Package org.elasticsearch.client.ml

Class GetCategoriesRequest

java.lang.Object
org.elasticsearch.client.ml.GetCategoriesRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GetCategoriesRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
A request to retrieve categories of a given job

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

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

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

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • 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.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

    • CATEGORY_ID

      public static final org.elasticsearch.common.xcontent.ParseField CATEGORY_ID

    • PARTITION_FIELD_VALUE

      public static final org.elasticsearch.common.xcontent.ParseField PARTITION_FIELD_VALUE

    • PARSER

      public static final org.elasticsearch.common.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

    • toXContent

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

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object