Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.datafeed

Class DatafeedUpdate

java.lang.Object

org.elasticsearch.xpack.core.ml.datafeed.DatafeedUpdate

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class DatafeedUpdate
extends Object
implements Writeable, ToXContentObject

A datafeed update contains partial properties to update a DatafeedConfig. The main difference between this class and DatafeedConfig is that here all fields are nullable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatafeedUpdate.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ObjectParser<DatafeedUpdate.Builder,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DatafeedUpdate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	affectsCrossProjectSearchSurface(DatafeedConfig current)	Returns true when this update changes index routing inputs that can alter whether a datafeed participates in cross-project search and therefore whether an internal cloud credential is required.
DatafeedConfig	apply(DatafeedConfig datafeedConfig, Map<String,String> headers, ClusterState clusterState)	Applies the update to the given DatafeedConfig
boolean	equals(Object other)	The lists of indices and types are compared for equality but they are not sorted first so this test could fail simply because the indices and types lists are in different orders.
DelayedDataCheckConfig	getDelayedDataCheckConfig()
String	getId()	Get the id of the datafeed to update
IndicesOptions	getIndicesOptions()
String	getJobId()
Integer	getMaxEmptySearches()
String	getProjectRouting()
Map<String,Object>	getRuntimeMappings()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final ObjectParser<DatafeedUpdate.Builder,Void> PARSER

Constructor Details

DatafeedUpdate

public DatafeedUpdate(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

getId

public String getId()

Get the id of the datafeed to update

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getJobId

public String getJobId()

getRuntimeMappings

public Map<String,Object> getRuntimeMappings()

getProjectRouting

public String getProjectRouting()

getDelayedDataCheckConfig

public DelayedDataCheckConfig getDelayedDataCheckConfig()

getMaxEmptySearches

public Integer getMaxEmptySearches()

getIndicesOptions

public IndicesOptions getIndicesOptions()

apply

public DatafeedConfig apply(DatafeedConfig datafeedConfig,
 Map<String,String> headers,
 ClusterState clusterState)

Applies the update to the given DatafeedConfig

Returns:

a new DatafeedConfig that contains the update

equals

public boolean equals(Object other)

The lists of indices and types are compared for equality but they are not sorted first so this test could fail simply because the indices and types lists are in different orders.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

affectsCrossProjectSearchSurface

public boolean affectsCrossProjectSearchSurface(DatafeedConfig current)

Returns true when this update changes index routing inputs that can alter whether a datafeed participates in cross-project search and therefore whether an internal cloud credential is required.