Package org.elasticsearch.client.ml

Class GetJobRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.GetJobRequest

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class GetJobRequest
extends ActionRequest
implements ToXContentObject

Request object to get Job objects with the matching jobIds or groupNames. _all explicitly gets all the jobs in the cluster An empty request (no jobIds) implicitly gets all the jobs 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 ParseField	JOB_IDS
static ConstructingObjectParser<GetJobRequest,java.lang.Void>	PARSER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetJobRequest(java.lang.String... jobIds)	Get the specified Job configurations via their unique jobIds

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
static GetJobRequest	getAllJobsRequest()	Helper method to create a query that will get ALL jobs
java.lang.Boolean	getAllowNoJobs()
java.util.List<java.lang.String>	getJobIds()	All the jobIds for which to get configuration information
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, 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

JOB_IDS

public static final ParseField JOB_IDS

ALLOW_NO_JOBS

public static final ParseField ALLOW_NO_JOBS

PARSER

public static final ConstructingObjectParser<GetJobRequest,java.lang.Void> PARSER

Constructor Detail

GetJobRequest

public GetJobRequest(java.lang.String... jobIds)

Get the specified Job configurations via their unique jobIds

Parameters:

jobIds - must not contain any null values

Method Detail

getAllJobsRequest

public static GetJobRequest getAllJobsRequest()

Helper method to create a query that will get ALL jobs

Returns:

new GetJobRequest object searching for the jobId "_all"

getJobIds

public java.util.List<java.lang.String> getJobIds()

All the jobIds for which to get configuration information

setAllowNoJobs

public void setAllowNoJobs(boolean allowNoJobs)

Whether to ignore if a wildcard expression matches no jobs.

Parameters:

allowNoJobs - If this is false, then an error is returned when a wildcard (or _all) does not match any jobs

getAllowNoJobs

public java.lang.Boolean getAllowNoJobs()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException