Package org.elasticsearch.client.ml

Class PreviewDatafeedRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.PreviewDatafeedRequest

All Implemented Interfaces:

Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class PreviewDatafeedRequest
extends ActionRequest
implements org.elasticsearch.xcontent.ToXContentObject

Request to preview a MachineLearning 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

Fields

Modifier and Type	Field	Description
static final org.elasticsearch.xcontent.ConstructingObjectParser<PreviewDatafeedRequest,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PreviewDatafeedRequest(String datafeedId)	Create a new request with the desired datafeedId
PreviewDatafeedRequest(DatafeedConfig datafeedConfig, Job jobConfig)	Create a new request to preview the provided datafeed config and optional job config

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static PreviewDatafeedRequest	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
DatafeedConfig	getDatafeedConfig()
String	getDatafeedId()
Job	getJobConfig()
int	hashCode()
String	toString()
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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

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

PARSER

public static final org.elasticsearch.xcontent.ConstructingObjectParser<PreviewDatafeedRequest,Void> PARSER

Constructor Details

PreviewDatafeedRequest

public PreviewDatafeedRequest(String datafeedId)

Create a new request with the desired datafeedId

Parameters:

datafeedId - unique datafeedId, must not be null

PreviewDatafeedRequest

public PreviewDatafeedRequest(DatafeedConfig datafeedConfig,
 Job jobConfig)

Create a new request to preview the provided datafeed config and optional job config

Parameters:

datafeedConfig - The datafeed to preview

jobConfig - The associated job config (required if the datafeed does not refer to an existing job)

Method Details

fromXContent

public static PreviewDatafeedRequest fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                                           throws IOException

Throws:

IOException

getDatafeedId

public String getDatafeedId()

getDatafeedConfig

public DatafeedConfig getDatafeedConfig()

getJobConfig

public Job getJobConfig()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

toXContent

public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                      throws IOException

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class TransportRequest

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object