Package org.elasticsearch.client.ml
Class GetDatafeedStatsRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetDatafeedStatsRequest
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class GetDatafeedStatsRequest extends ActionRequest implements ToXContentObject
Request object to get
DatafeedStats
by their respective datafeedIds
_all
explicitly gets all the datafeeds' statistics in the cluster
An empty request (no datafeedId
s) implicitly gets all the datafeeds' statistics 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 ConstructingObjectParser<GetDatafeedStatsRequest,java.lang.Void>
PARSER
-
Constructor Summary
Constructors Constructor Description GetDatafeedStatsRequest(java.lang.String... datafeedIds)
Get the specified Datafeed's statistics via their unique datafeedIds -
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static GetDatafeedStatsRequest
getAllDatafeedStatsRequest()
Explicitly gets all datafeeds statisticsjava.lang.Boolean
getAllowNoDatafeeds()
java.util.List<java.lang.String>
getDatafeedIds()
All the datafeedIds for which to get statisticsint
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
-
GetDatafeedStatsRequest
public GetDatafeedStatsRequest(java.lang.String... datafeedIds)Get the specified Datafeed's statistics via their unique datafeedIds- Parameters:
datafeedIds
- must be non-null and each datafeedId must be non-null
-
-
Method Details
-
getAllDatafeedStatsRequest
Explicitly gets all datafeeds statistics- Returns:
- a
GetDatafeedStatsRequest
for all existing datafeeds
-
getDatafeedIds
public java.util.List<java.lang.String> getDatafeedIds()All the datafeedIds for which to get statistics -
getAllowNoDatafeeds
public java.lang.Boolean getAllowNoDatafeeds() -
setAllowNoDatafeeds
public void setAllowNoDatafeeds(boolean allowNoDatafeeds)Whether to ignore if a wildcard expression matches no datafeeds. This includes_all
string or when no datafeeds have been specified- Parameters:
allowNoDatafeeds
- Whentrue
ignore if wildcard or_all
matches no datafeeds. Defaults totrue
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object other)- Overrides:
equals
in classjava.lang.Object
-
validate
- Specified by:
validate
in classActionRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-