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:
Streamable
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class StartDatafeedRequest extends ActionRequest implements 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.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
END
static ConstructingObjectParser<StartDatafeedRequest,java.lang.Void>
PARSER
static ParseField
START
static ParseField
TIMEOUT
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description StartDatafeedRequest(java.lang.String datafeedId)
Create a new StartDatafeedRequest for the given DatafeedId
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getDatafeedId()
java.lang.String
getEnd()
java.lang.String
getStart()
TimeValue
getTimeout()
int
hashCode()
void
setEnd(java.lang.String end)
The time that the datafeed should end.void
setStart(java.lang.String start)
The time that the datafeed should begin.void
setTimeout(TimeValue timeout)
Indicates how long to wait for the cluster to respond to the request.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException
validate()
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, readFrom, 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
-
START
public static final ParseField START
-
END
public static final ParseField END
-
TIMEOUT
public static final ParseField TIMEOUT
-
PARSER
public static ConstructingObjectParser<StartDatafeedRequest,java.lang.Void> PARSER
-
-
Method Detail
-
getDatafeedId
public java.lang.String getDatafeedId()
-
getStart
public java.lang.String getStart()
-
setStart
public void setStart(java.lang.String start)
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
public java.lang.String getEnd()
-
setEnd
public void setEnd(java.lang.String end)
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 TimeValue getTimeout()
-
setTimeout
public void setTimeout(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
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- 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
-
-