Package org.elasticsearch.client.ml
Class GetDatafeedRequest
java.lang.Object
org.elasticsearch.client.ml.GetDatafeedRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class GetDatafeedRequest
extends Object
implements Validatable, org.elasticsearch.common.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 interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ParseField
static org.elasticsearch.common.xcontent.ParseField
static String
static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetDatafeedRequest,Void>
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
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.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Field Details
-
DATAFEED_IDS
public static final org.elasticsearch.common.xcontent.ParseField DATAFEED_IDS -
ALLOW_NO_MATCH
public static final org.elasticsearch.common.xcontent.ParseField ALLOW_NO_MATCH -
EXCLUDE_GENERATED
- See Also:
- Constant Field Values
-
PARSER
public static final org.elasticsearch.common.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
-
hashCode
public int hashCode() -
equals
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
IOException
-