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 jobIds) 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>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	ALLOW_NO_JOBS
static ConstructingObjectParser<GetJobStatsRequest,Void>	PARSER

Fields inherited from interface org.elasticsearch.common.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	getAllowNoJobs()
List<String>	getJobIds()	All the jobIds for which to get statistics
int	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, 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,Void> PARSER

Constructor Detail

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 Detail

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

getAllowNoJobs

public 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 - 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 ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException