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:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class GetJobRequest
extends ActionRequest
implements org.elasticsearch.xcontent.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.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.elasticsearch.xcontent.ParseField	ALLOW_NO_MATCH
static final String	EXCLUDE_GENERATED
static final org.elasticsearch.xcontent.ParseField	JOB_IDS
static final org.elasticsearch.xcontent.ConstructingObjectParser<GetJobRequest,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static GetJobRequest	getAllJobsRequest()	Helper method to create a query that will get ALL jobs
Boolean	getAllowNoMatch()
Boolean	getExcludeGenerated()
List<String>	getJobIds()	All the jobIds for which to get configuration information
int	hashCode()
void	setAllowNoMatch(boolean allowNoMatch)	Whether to ignore if a wildcard expression matches no jobs.
void	setExcludeGenerated(boolean excludeGenerated)	Setting this flag to `true` removes certain fields from the configuration on retrieval.
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

JOB_IDS

public static final org.elasticsearch.xcontent.ParseField JOB_IDS

ALLOW_NO_MATCH

public static final org.elasticsearch.xcontent.ParseField ALLOW_NO_MATCH

EXCLUDE_GENERATED

public static final String EXCLUDE_GENERATED

See Also:

• Constant Field Values

PARSER

public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetJobRequest,Void> PARSER

Constructor Details

GetJobRequest

public GetJobRequest(String... jobIds)

Get the specified Job configurations via their unique jobIds

Parameters:

jobIds - must not contain any null values

Method Details

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 List<String> getJobIds()

All the jobIds for which to get configuration information

setAllowNoMatch

public void setAllowNoMatch(boolean allowNoMatch)

Whether to ignore if a wildcard expression matches no jobs.

Parameters:

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

getAllowNoMatch

public Boolean getAllowNoMatch()

setExcludeGenerated

public void setExcludeGenerated(boolean excludeGenerated)

Setting this flag to `true` removes certain fields from the configuration on retrieval. This is useful when getting the configuration and wanting to put it in another cluster. Default value is false.

Parameters:

excludeGenerated - Boolean value indicating if certain fields should be removed

getExcludeGenerated

public Boolean getExcludeGenerated()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException