Package org.elasticsearch.client.ml

Class OpenJobRequest

java.lang.Object
org.elasticsearch.client.ml.OpenJobRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class OpenJobRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request to open a Machine Learning 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.ConstructingObjectParser<OpenJobRequest,​Void>
    PARSER
     
    static org.elasticsearch.common.xcontent.ParseField
    TIMEOUT
     

    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
    OpenJobRequest​(String jobId)
    Create a new request with the desired jobId

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object other)
     
    static OpenJobRequest
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    String
    getJobId()
     
    org.elasticsearch.core.TimeValue
    getTimeout()
     
    int
    hashCode()
     
    void
    setJobId​(String jobId)
    The jobId to open
    void
    setTimeout​(org.elasticsearch.core.TimeValue timeout)
    How long to wait for job to open before timing out the request
    String
    toString()
     
    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, wait, wait, wait

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

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

    • TIMEOUT

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

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<OpenJobRequest,​Void> PARSER

  • Constructor Details

    • OpenJobRequest

      public OpenJobRequest​(String jobId)
      Create a new request with the desired jobId
      Parameters:
      jobId - unique jobId, must not be null

  • Method Details

    • fromXContent

      public static OpenJobRequest fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • getJobId

      public String getJobId()

    • setJobId

      public void setJobId​(String jobId)
      The jobId to open
      Parameters:
      jobId - unique jobId, must not be null

    • getTimeout

      public org.elasticsearch.core.TimeValue getTimeout()

    • setTimeout

      public void setTimeout​(org.elasticsearch.core.TimeValue timeout)
      How long to wait for job to open before timing out the request
      Parameters:
      timeout - default value of 30 minutes

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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