Package org.elasticsearch.client.ml

Class GetOverallBucketsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetOverallBucketsRequest
All Implemented Interfaces:
Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class GetOverallBucketsRequest extends ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
A request to retrieve overall buckets of set of jobs

  • Field Details

    • TOP_N

      public static final org.elasticsearch.xcontent.ParseField TOP_N

    • BUCKET_SPAN

      public static final org.elasticsearch.xcontent.ParseField BUCKET_SPAN

    • OVERALL_SCORE

      public static final org.elasticsearch.xcontent.ParseField OVERALL_SCORE

    • EXCLUDE_INTERIM

      public static final org.elasticsearch.xcontent.ParseField EXCLUDE_INTERIM

    • START

      public static final org.elasticsearch.xcontent.ParseField START

    • END

      public static final org.elasticsearch.xcontent.ParseField END

    • ALLOW_NO_MATCH

      public static final org.elasticsearch.xcontent.ParseField ALLOW_NO_MATCH

    • PARSER

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

  • Constructor Details

    • GetOverallBucketsRequest

      public GetOverallBucketsRequest(String... jobIds)
      Constructs a request to retrieve overall buckets for a set of jobs
      Parameters:
      jobIds - The job identifiers. Each can be a job identifier, a group name, or a wildcard expression.

    • GetOverallBucketsRequest

      public GetOverallBucketsRequest(List<String> jobIds)
      Constructs a request to retrieve overall buckets for a set of jobs
      Parameters:
      jobIds - The job identifiers. Each can be a job identifier, a group name, or a wildcard expression.

  • Method Details

    • getJobIds

      public List<String> getJobIds()

    • getTopN

      public Integer getTopN()

    • setTopN

      public void setTopN(Integer topN)
      Sets the value of "top_n".
      Parameters:
      topN - The number of top job bucket scores to be used in the overall_score calculation. Defaults to 1.

    • getBucketSpan

      public org.elasticsearch.core.TimeValue getBucketSpan()

    • setBucketSpan

      public void setBucketSpan(org.elasticsearch.core.TimeValue bucketSpan)
      Sets the value of "bucket_span".
      Parameters:
      bucketSpan - The span of the overall buckets. Must be greater or equal to the largest job’s bucket_span. Defaults to the largest job’s bucket_span.

    • isExcludeInterim

      public boolean isExcludeInterim()

    • setExcludeInterim

      public void setExcludeInterim(Boolean excludeInterim)
      Sets the value of "exclude_interim". When true, interim overall buckets will be filtered out. Overall buckets are interim if any of the job buckets within the overall bucket interval are interim.
      Parameters:
      excludeInterim - value of "exclude_interim" to be set

    • getStart

      public String getStart()

    • setStart

      public void setStart(String start)
      Sets the value of "start" which is a timestamp. Only overall buckets whose timestamp is on or after the "start" value will be returned.
      Parameters:
      start - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getEnd

      public String getEnd()

    • setEnd

      public void setEnd(String end)
      Sets the value of "end" which is a timestamp. Only overall buckets whose timestamp is before the "end" value will be returned.
      Parameters:
      end - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getOverallScore

      public Double getOverallScore()

    • setOverallScore

      public void setOverallScore(double overallScore)
      Sets the value of "overall_score". Only buckets with "overall_score" equal or greater will be returned.
      Parameters:
      overallScore - value of "anomaly_score".

    • setAllowNoMatch

      public void setAllowNoMatch(boolean allowNoMatch)
      See GetJobRequest.getAllowNoMatch()
      Parameters:
      allowNoMatch - value of "allow_no_match".

    • getAllowNoMatch

      public Boolean getAllowNoMatch()
      Whether to ignore if a wildcard expression matches no jobs. If this is false, then an error is returned when a wildcard (or _all) does not match any jobs

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class 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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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