Package org.elasticsearch.client.ml
Class GetDatafeedRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetDatafeedRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class GetDatafeedRequest
extends ActionRequest
implements org.elasticsearch.xcontent.ToXContentObject
Request object to get
DatafeedConfig
objects with the matching datafeedId
s.
_all
explicitly gets all the datafeeds in the cluster
An empty request (no datafeedId
s) implicitly gets all the datafeeds 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
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final String
static final org.elasticsearch.xcontent.ConstructingObjectParser<GetDatafeedRequest,
Void> Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionGetDatafeedRequest
(String... datafeedIds) Get the specifiedDatafeedConfig
configurations via their unique datafeedIds -
Method Summary
Modifier and TypeMethodDescriptionboolean
static GetDatafeedRequest
Helper method to create a query that will get ALL datafeedsAll the datafeedIds for which to get configuration informationint
hashCode()
void
setAllowNoMatch
(boolean allowNoMatch) Whether to ignore if a wildcard expression matches no datafeeds.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) 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
-
DATAFEED_IDS
public static final org.elasticsearch.xcontent.ParseField DATAFEED_IDS -
ALLOW_NO_MATCH
public static final org.elasticsearch.xcontent.ParseField ALLOW_NO_MATCH -
EXCLUDE_GENERATED
- See Also:
-
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetDatafeedRequest,Void> PARSER
-
-
Constructor Details
-
GetDatafeedRequest
Get the specifiedDatafeedConfig
configurations via their unique datafeedIds- Parameters:
datafeedIds
- must not contain any null values
-
-
Method Details
-
getAllDatafeedsRequest
Helper method to create a query that will get ALL datafeeds- Returns:
- new
GetDatafeedRequest
object searching for the datafeedId "_all"
-
getDatafeedIds
All the datafeedIds for which to get configuration information -
setAllowNoMatch
public void setAllowNoMatch(boolean allowNoMatch) Whether to ignore if a wildcard expression matches no datafeeds.- Parameters:
allowNoMatch
- If this isfalse
, then an error is returned when a wildcard (or_all
) does not match any datafeeds
-
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
- Specified by:
validate
in classActionRequest
-
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
-