Package org.elasticsearch.client.ml

Class GetJobStatsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetJobStatsRequest
All Implemented Interfaces:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class GetJobStatsRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
Request object to get JobStats by their respective jobIds _all explicitly gets all the jobs' statistics in the cluster An empty request (no jobIds) implicitly gets all the jobs' statistics 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.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    ALLOW_NO_MATCH
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<GetJobStatsRequest,Void>
    PARSER
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetJobStatsRequest(String... jobIds)
    Get the specified Job's statistics via their unique jobIds

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object other)
     
    static GetJobStatsRequest
    getAllJobStatsRequest()
    Explicitly gets all jobs statistics
    Boolean
    getAllowNoMatch()
     
    List<String>
    getJobIds()
    All the jobIds for which to get statistics
    int
    hashCode()
     
    void
    setAllowNoMatch(boolean allowNoMatch)
    Whether to ignore if a wildcard expression matches no jobs.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.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, toString

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

    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.xcontent.ToXContentObject

    isFragment

  • Field Details

    • ALLOW_NO_MATCH

      public static final org.elasticsearch.xcontent.ParseField ALLOW_NO_MATCH

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetJobStatsRequest,Void> PARSER

  • Constructor Details

    • GetJobStatsRequest

      public GetJobStatsRequest(String... jobIds)
      Get the specified Job's statistics via their unique jobIds
      Parameters:
      jobIds - must be non-null and each jobId must be non-null

  • Method Details

    • getAllJobStatsRequest

      public static GetJobStatsRequest getAllJobStatsRequest()
      Explicitly gets all jobs statistics
      Returns:
      a GetJobStatsRequest for all existing jobs

    • getJobIds

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

    • getAllowNoMatch

      public Boolean getAllowNoMatch()

    • setAllowNoMatch

      public void setAllowNoMatch(boolean allowNoMatch)
      Whether to ignore if a wildcard expression matches no jobs. This includes _all string or when no jobs have been specified
      Parameters:
      allowNoMatch - When true ignore if wildcard or _all matches no jobs. Defaults to true

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • validate

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

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException