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.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class GetCategoriesRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.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.common.xcontent.ToXContent

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

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

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

  • Field Summary

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

    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()  
    java.lang.String getPartitionFieldValue()  
    int hashCode()  
    void setCategoryId​(java.lang.Long categoryId)
    Sets the category id
    void setPageParams​(PageParams pageParams)
    Sets the paging parameters
    void setPartitionFieldValue​(java.lang.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)  
    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

    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 Details

    • CATEGORY_ID

      public static final org.elasticsearch.common.ParseField CATEGORY_ID

    • PARTITION_FIELD_VALUE

      public static final org.elasticsearch.common.ParseField PARTITION_FIELD_VALUE

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<GetCategoriesRequest,​java.lang.Void> PARSER

  • Constructor Details

    • GetCategoriesRequest

      public GetCategoriesRequest​(java.lang.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 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

    • getPartitionFieldValue

      public java.lang.String getPartitionFieldValue()

    • setPartitionFieldValue

      public void setPartitionFieldValue​(java.lang.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.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object