Package org.elasticsearch.client.ml

Class GetJobRequest

java.lang.Object
org.elasticsearch.client.ml.GetJobRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GetJobRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request object to get Job objects with the matching jobIds or groupNames. _all explicitly gets all the jobs in the cluster An empty request (no jobIds) implicitly gets all the jobs in the cluster

  • 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
    ALLOW_NO_MATCH
     
    static String
    EXCLUDE_GENERATED
     
    static org.elasticsearch.common.xcontent.ParseField
    JOB_IDS
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetJobRequest,​Void>
    PARSER
     

    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
    GetJobRequest​(String... jobIds)
    Get the specified Job configurations via their unique jobIds

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object other)
     
    static GetJobRequest
    getAllJobsRequest()
    Helper method to create a query that will get ALL jobs
    Boolean
    getAllowNoMatch()
     
    Boolean
    getExcludeGenerated()
     
    List<String>
    getJobIds()
    All the jobIds for which to get configuration information
    int
    hashCode()
     
    void
    setAllowNoMatch​(boolean allowNoMatch)
    Whether to ignore if a wildcard expression matches no jobs.
    void
    setExcludeGenerated​(boolean excludeGenerated)
    Setting this flag to `true` removes certain fields from the configuration on retrieval.
    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

    • JOB_IDS

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

    • ALLOW_NO_MATCH

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

    • EXCLUDE_GENERATED

      public static final String EXCLUDE_GENERATED
      See Also:
      Constant Field Values

    • PARSER

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

  • Constructor Details

    • GetJobRequest

      public GetJobRequest​(String... jobIds)
      Get the specified Job configurations via their unique jobIds
      Parameters:
      jobIds - must not contain any null values

  • Method Details

    • getAllJobsRequest

      public static GetJobRequest getAllJobsRequest()
      Helper method to create a query that will get ALL jobs
      Returns:
      new GetJobRequest object searching for the jobId "_all"

    • getJobIds

      public List<String> getJobIds()
      All the jobIds for which to get configuration information

    • setAllowNoMatch

      public void setAllowNoMatch​(boolean allowNoMatch)
      Whether to ignore if a wildcard expression matches no jobs.
      Parameters:
      allowNoMatch - If this is false, then an error is returned when a wildcard (or _all) does not match any jobs

    • getAllowNoMatch

      public Boolean getAllowNoMatch()

    • setExcludeGenerated

      public void setExcludeGenerated​(boolean excludeGenerated)
      Setting this flag to `true` removes certain fields from the configuration on retrieval. This is useful when getting the configuration and wanting to put it in another cluster. Default value is false.
      Parameters:
      excludeGenerated - Boolean value indicating if certain fields should be removed

    • getExcludeGenerated

      public Boolean getExcludeGenerated()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals​(Object other)
      Overrides:
      equals 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