Package org.elasticsearch.client.ml
Class GetJobStatsRequest
java.lang.Object
org.elasticsearch.client.ml.GetJobStatsRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class GetJobStatsRequest
extends Object
implements Validatable, org.elasticsearch.common.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 jobId
s) implicitly gets all the jobs' statistics 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
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetJobStatsRequest,Void>
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionGetJobStatsRequest(String... jobIds)
Get the specified Job's statistics via their unique jobIds -
Method Summary
Modifier and TypeMethodDescriptionboolean
static GetJobStatsRequest
Explicitly gets all jobs statisticsAll the jobIds for which to get statisticsint
hashCode()
void
setAllowNoMatch(boolean allowNoMatch)
Whether to ignore if a wildcard expression matches no jobs.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
-
ALLOW_NO_MATCH
public static final org.elasticsearch.common.xcontent.ParseField ALLOW_NO_MATCH -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<GetJobStatsRequest,Void> PARSER
-
-
Constructor Details
-
GetJobStatsRequest
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
Explicitly gets all jobs statistics- Returns:
- a
GetJobStatsRequest
for all existing jobs
-
getJobIds
All the jobIds for which to get statistics -
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
- Whentrue
ignore if wildcard or_all
matches no jobs. Defaults totrue
-
hashCode
public int hashCode() -
equals
-
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 interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
IOException
-