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, ToXContent, ToXContentObject, TaskAwareRequest

public class GetDatafeedRequest
extends ActionRequest
implements 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.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	ALLOW_NO_DATAFEEDS
static ParseField	DATAFEED_IDS
static ConstructingObjectParser<GetDatafeedRequest,Void>	PARSER

Fields inherited from interface org.elasticsearch.common.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	getAllowNoDatafeeds()
List<String>	getDatafeedIds()	All the datafeedIds for which to get configuration information
int	hashCode()
void	setAllowNoDatafeeds(boolean allowNoDatafeeds)	Whether to ignore if a wildcard expression matches no datafeeds.
XContentBuilder	toXContent(XContentBuilder builder, 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

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

DATAFEED_IDS

public static final ParseField DATAFEED_IDS

ALLOW_NO_DATAFEEDS

public static final ParseField ALLOW_NO_DATAFEEDS

PARSER

public static final ConstructingObjectParser<GetDatafeedRequest,Void> PARSER

Constructor Detail

GetDatafeedRequest

public GetDatafeedRequest(String... datafeedIds)

Get the specified DatafeedConfig configurations via their unique datafeedIds

Parameters:

datafeedIds - must not contain any null values

Method Detail

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

setAllowNoDatafeeds

public void setAllowNoDatafeeds(boolean allowNoDatafeeds)

Whether to ignore if a wildcard expression matches no datafeeds.

Parameters:

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

getAllowNoDatafeeds

public Boolean getAllowNoDatafeeds()

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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException