Package org.elasticsearch.client.ml

Class OpenJobRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.OpenJobRequest
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 OpenJobRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Request to open a Machine Learning 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.xcontent.ConstructingObjectParser<OpenJobRequest,​java.lang.Void> PARSER  
    static org.elasticsearch.common.ParseField TIMEOUT  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    OpenJobRequest​(java.lang.String jobId)
    Create a new request with the desired jobId

  • Method Summary

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

    • TIMEOUT

      public static final org.elasticsearch.common.ParseField TIMEOUT

    • PARSER

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

  • Constructor Details

    • OpenJobRequest

      public OpenJobRequest​(java.lang.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 java.io.IOException
      Throws:
      java.io.IOException

    • getJobId

      public java.lang.String getJobId()

    • setJobId

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

    • getTimeout

      public org.elasticsearch.common.unit.TimeValue getTimeout()

    • setTimeout

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

    • 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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • hashCode

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

    • equals

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