Package org.elasticsearch.client.ml

Class DeleteForecastRequest

java.lang.Object
org.elasticsearch.client.ml.DeleteForecastRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class DeleteForecastRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
POJO for a delete forecast request

  • 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 String
    ALL
     
    static org.elasticsearch.common.xcontent.ParseField
    ALLOW_NO_FORECASTS
     
    static org.elasticsearch.common.xcontent.ParseField
    FORECAST_ID
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<DeleteForecastRequest,​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
    DeleteForecastRequest​(String jobId)
    Create a new DeleteForecastRequest for the given Job ID

  • Method Summary

    Modifier and Type
    Method
    Description
    static DeleteForecastRequest
    deleteAllForecasts​(String jobId)
    Create a new DeleteForecastRequest that explicitly deletes all forecasts
    boolean
    equals​(Object other)
     
    Boolean
    getAllowNoForecasts()
     
    List<String>
    getForecastIds()
     
    String
    getJobId()
     
    int
    hashCode()
     
    void
    setAllowNoForecasts​(boolean allowNoForecasts)
    Sets the value of "allow_no_forecasts".
    void
    setForecastIds​(String... forecastIds)
    The forecast IDs to delete.
    org.elasticsearch.core.TimeValue
    timeout()
     
    void
    timeout​(String timeout)
    Allows to set the timeout
    void
    timeout​(org.elasticsearch.core.TimeValue timeout)
    Allows to set the timeout
    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

    • FORECAST_ID

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

    • ALLOW_NO_FORECASTS

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

    • TIMEOUT

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

    • ALL

      public static final String ALL
      See Also:
      Constant Field Values

    • PARSER

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

  • Constructor Details

    • DeleteForecastRequest

      public DeleteForecastRequest​(String jobId)
      Create a new DeleteForecastRequest for the given Job ID
      Parameters:
      jobId - the jobId of the Job whose forecast(s) to delete

  • Method Details

    • deleteAllForecasts

      public static DeleteForecastRequest deleteAllForecasts​(String jobId)
      Create a new DeleteForecastRequest that explicitly deletes all forecasts
      Parameters:
      jobId - the jobId of the Job whose forecasts to delete

    • getJobId

      public String getJobId()

    • getForecastIds

      public List<String> getForecastIds()

    • setForecastIds

      public void setForecastIds​(String... forecastIds)
      The forecast IDs to delete. Can be also be ALL to explicitly delete ALL forecasts
      Parameters:
      forecastIds - forecast IDs to delete

    • getAllowNoForecasts

      public Boolean getAllowNoForecasts()

    • setAllowNoForecasts

      public void setAllowNoForecasts​(boolean allowNoForecasts)
      Sets the value of "allow_no_forecasts".
      Parameters:
      allowNoForecasts - when true no error is thrown when ALL does not find any forecasts

    • timeout

      public void timeout​(String timeout)
      Allows to set the timeout
      Parameters:
      timeout - timeout as a string (e.g. 1s)

    • timeout

      public void timeout​(org.elasticsearch.core.TimeValue timeout)
      Allows to set the timeout
      Parameters:
      timeout - timeout as a TimeValue

    • timeout

      public org.elasticsearch.core.TimeValue timeout()

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • 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