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 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.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
Field Summary
Fields Modifier and Type Field Description static ParseField
ALLOW_NO_DATAFEEDS
static ParseField
DATAFEED_IDS
static ConstructingObjectParser<GetDatafeedRequest,java.lang.Void>
PARSER
-
Constructor Summary
Constructors Constructor Description GetDatafeedRequest(java.lang.String... datafeedIds)
Get the specifiedDatafeedConfig
configurations via their unique datafeedIds -
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static GetDatafeedRequest
getAllDatafeedsRequest()
Helper method to create a query that will get ALL datafeedsjava.lang.Boolean
getAllowNoDatafeeds()
java.util.List<java.lang.String>
getDatafeedIds()
All the datafeedIds for which to get configuration informationint
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.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
-
Field Details
-
Constructor Details
-
GetDatafeedRequest
public GetDatafeedRequest(java.lang.String... datafeedIds)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
public java.util.List<java.lang.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 isfalse
, then an error is returned when a wildcard (or_all
) does not match any datafeeds
-
getAllowNoDatafeeds
public java.lang.Boolean getAllowNoDatafeeds() -
validate
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object other)- Overrides:
equals
in classjava.lang.Object
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-