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 datafeedIds. _all explicitly gets all the datafeeds in the cluster An empty request (no datafeedIds) 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

Fields

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

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetDatafeedRequest(String... datafeedIds)	Get the specified DatafeedConfig configurations via their unique datafeedIds

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static GetDatafeedRequest	getAllDatafeedsRequest()	Helper method to create a query that will get ALL datafeeds
Boolean	getAllowNoMatch()
List<String>	getDatafeedIds()	All the datafeedIds for which to get configuration information
Boolean	getExcludeGenerated()
int	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)
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

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

public static final String EXCLUDE_GENERATED

See Also:

• Constant Field Values

PARSER

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

Constructor Details

GetDatafeedRequest

public GetDatafeedRequest(String... datafeedIds)

Get the specified DatafeedConfig configurations via their unique datafeedIds

Parameters:

datafeedIds - must not contain any null values

Method Details

getAllDatafeedsRequest

public static GetDatafeedRequest getAllDatafeedsRequest()

Helper method to create a query that will get ALL datafeeds

Returns:

new GetDatafeedRequest object searching for the datafeedId "_all"

getDatafeedIds

public List<String> 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 is false, then an error is returned when a wildcard (or _all) does not match any datafeeds

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