Package org.elasticsearch.client.ml

Class GetJobRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetJobRequest
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class GetJobRequest
extends org.elasticsearch.action.ActionRequest
implements 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 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 ALLOW_NO_MATCH  
    static java.lang.String EXCLUDE_GENERATED  
    static org.elasticsearch.common.ParseField JOB_IDS  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetJobRequest,​java.lang.Void> PARSER  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    GetJobRequest​(java.lang.String... jobIds)
    Get the specified Job configurations via their unique jobIds

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)  
    static GetJobRequest getAllJobsRequest()
    Helper method to create a query that will get ALL jobs
    java.lang.Boolean getAllowNoMatch()  
    java.lang.Boolean getExcludeGenerated()  
    java.util.List<java.lang.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)  
    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

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    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

    • JOB_IDS

      public static final org.elasticsearch.common.ParseField JOB_IDS

    • ALLOW_NO_MATCH

      public static final org.elasticsearch.common.ParseField ALLOW_NO_MATCH

    • EXCLUDE_GENERATED

      public static final java.lang.String EXCLUDE_GENERATED
      See Also:
      Constant Field Values

    • PARSER

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

  • Constructor Details

    • GetJobRequest

      public GetJobRequest​(java.lang.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 java.util.List<java.lang.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 java.lang.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 java.lang.Boolean getExcludeGenerated()

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest

    • 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

    • 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