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:
org.elasticsearch.common.io.stream.Writeable
,org.elasticsearch.core.RefCounted
,org.elasticsearch.tasks.TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class GetJobRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.xcontent.ToXContentObject
Request object to get
Job
objects with the matching jobId
s or
groupName
s.
_all
explicitly gets all the jobs in the cluster
An empty request (no jobId
s) implicitly gets all the jobs in the cluster-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
org.elasticsearch.transport.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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final String
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<GetJobRequest,
Void> Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionGetJobRequest
(String... jobIds) Get the specifiedJob
configurations via their unique jobIds -
Method Summary
Modifier and TypeMethodDescriptionboolean
static GetJobRequest
Helper method to create a query that will get ALL jobsAll the jobIds for which to get configuration informationint
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) org.elasticsearch.action.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
- See Also:
-
PARSER
-
-
Constructor Details
-
GetJobRequest
Get the specifiedJob
configurations via their unique jobIds- Parameters:
jobIds
- must not contain any null values
-
-
Method Details
-
getAllJobsRequest
Helper method to create a query that will get ALL jobs- Returns:
- new
GetJobRequest
object searching for the jobId "_all"
-
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 isfalse
, then an error is returned when a wildcard (or_all
) does not match any jobs
-
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
-
validate
public org.elasticsearch.action.ActionRequestValidationException validate()- Specified by:
validate
in classorg.elasticsearch.action.ActionRequest
-
hashCode
public int hashCode() -
equals
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-