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:
Streamable
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class GetJobStatsRequest extends ActionRequest implements ToXContentObject
Request object to getJobStats
by their respective jobIds_all
explicitly gets all the jobs' statistics in the cluster An empty request (nojobId
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
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
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.action.ActionRequest
getShouldStoreResult, readFrom, writeTo
-
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
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Field Detail
-
ALLOW_NO_JOBS
public static final ParseField ALLOW_NO_JOBS
-
PARSER
public static final ConstructingObjectParser<GetJobStatsRequest,java.lang.Void> PARSER
-
-
Method Detail
-
getAllJobStatsRequest
public static GetJobStatsRequest 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
public ActionRequestValidationException 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
-
-