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:
Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class GetJobStatsRequest extends ActionRequest implements 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 class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
Field Summary
Fields Modifier and Type Field Description static ParseField
ALLOW_NO_JOBS
static ConstructingObjectParser<GetJobStatsRequest,java.lang.Void>
PARSER
-
Constructor Summary
Constructors Constructor Description GetJobStatsRequest(java.lang.String... jobIds)
Get the specified Job's statistics via their unique jobIds -
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static GetJobStatsRequest
getAllJobStatsRequest()
Explicitly gets all jobs statisticsjava.lang.Boolean
getAllowNoJobs()
java.util.List<java.lang.String>
getJobIds()
All the jobIds for which to get statisticsint
hashCode()
void
setAllowNoJobs(boolean allowNoJobs)
Whether to ignore if a wildcard expression matches no jobs.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
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
-
Field Details
-
Constructor Details
-
GetJobStatsRequest
public GetJobStatsRequest(java.lang.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
Explicitly gets all jobs statistics- Returns:
- a
GetJobStatsRequest
for all existing jobs
-
getJobIds
public java.util.List<java.lang.String> getJobIds()All the jobIds for which to get statistics -
getAllowNoJobs
public java.lang.Boolean getAllowNoJobs() -
setAllowNoJobs
public void setAllowNoJobs(boolean allowNoJobs)Whether to ignore if a wildcard expression matches no jobs. This includes_all
string or when no jobs have been specified- Parameters:
allowNoJobs
- Whentrue
ignore if wildcard or_all
matches no jobs. Defaults totrue
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object other)- Overrides:
equals
in classjava.lang.Object
-
validate
- Specified by:
validate
in classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-