Package org.elasticsearch.client.ml
Class StartDatafeedRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.StartDatafeedRequest
- All Implemented Interfaces:
Writeable
,org.elasticsearch.core.RefCounted
,TaskAwareRequest
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class StartDatafeedRequest
extends ActionRequest
implements org.elasticsearch.xcontent.ToXContentObject
Request to start a Datafeed
-
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
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ConstructingObjectParser<StartDatafeedRequest,
Void> static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionStartDatafeedRequest
(String datafeedId) Create a new StartDatafeedRequest for the given DatafeedId -
Method Summary
Modifier and TypeMethodDescriptionboolean
getEnd()
getStart()
org.elasticsearch.core.TimeValue
int
hashCode()
void
The time that the datafeed should end.void
The time that the datafeed should begin.void
setTimeout
(org.elasticsearch.core.TimeValue timeout) Indicates how long to wait for the cluster to respond to the request.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) 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
-
START
public static final org.elasticsearch.xcontent.ParseField START -
END
public static final org.elasticsearch.xcontent.ParseField END -
TIMEOUT
public static final org.elasticsearch.xcontent.ParseField TIMEOUT -
PARSER
public static final org.elasticsearch.xcontent.ConstructingObjectParser<StartDatafeedRequest,Void> PARSER
-
-
Constructor Details
-
StartDatafeedRequest
Create a new StartDatafeedRequest for the given DatafeedId- Parameters:
datafeedId
- non-null existing Datafeed ID
-
-
Method Details
-
getDatafeedId
-
getStart
-
setStart
The time that the datafeed should begin. This value is inclusive. If you specify a start value that is earlier than the timestamp of the latest processed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record. If you do not specify a start time and the datafeed is associated with a new job, the analysis starts from the earliest time for which data is available.- Parameters:
start
- String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO 8601 string
-
getEnd
-
setEnd
The time that the datafeed should end. This value is exclusive. If you do not specify an end time, the datafeed runs continuously.- Parameters:
end
- String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO 8601 string
-
getTimeout
public org.elasticsearch.core.TimeValue getTimeout() -
setTimeout
public void setTimeout(org.elasticsearch.core.TimeValue timeout) Indicates how long to wait for the cluster to respond to the request.- Parameters:
timeout
- TimeValue for how long to wait for a response from the cluster
-
validate
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode() -
equals
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-