Package org.elasticsearch.client.ml

Class UpdateFilterRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.client.ml.UpdateFilterRequest

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class UpdateFilterRequest
extends ActionRequest
implements ToXContentObject

Updates an existing MlFilter configuration

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>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	ADD_ITEMS
static ConstructingObjectParser<UpdateFilterRequest,Void>	PARSER
static ParseField	REMOVE_ITEMS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
UpdateFilterRequest(String filterId)	Construct a new request referencing a non-null, existing filter_id

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SortedSet<String>	getAddItems()
String	getDescription()	Returns optional description of the request to be displayed by the task manager
String	getFilterId()
SortedSet<String>	getRemoveItems()
int	hashCode()
void	setAddItems(Collection<String> addItems)	The collection of items to add to the filter
void	setDescription(String description)	The new description of the filter
void	setRemoveItems(Collection<String> removeItems)	The collection of items to remove from the filter
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, 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

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

ADD_ITEMS

public static final ParseField ADD_ITEMS

REMOVE_ITEMS

public static final ParseField REMOVE_ITEMS

PARSER

public static final ConstructingObjectParser<UpdateFilterRequest,Void> PARSER

Constructor Detail

UpdateFilterRequest

public UpdateFilterRequest(String filterId)

Construct a new request referencing a non-null, existing filter_id

Parameters:

filterId - Id referencing the filter to update

Method Detail

getFilterId

public String getFilterId()

getDescription

public String getDescription()

Description copied from interface: TaskAwareRequest

Returns optional description of the request to be displayed by the task manager

Specified by:

getDescription in interface TaskAwareRequest

setDescription

public void setDescription(String description)

The new description of the filter

Parameters:

description - the updated filter description

getAddItems

public SortedSet<String> getAddItems()

setAddItems

public void setAddItems(Collection<String> addItems)

The collection of items to add to the filter

Parameters:

addItems - non-null items to add to the filter, defaults to empty array

getRemoveItems

public SortedSet<String> getRemoveItems()

setRemoveItems

public void setRemoveItems(Collection<String> removeItems)

The collection of items to remove from the filter

Parameters:

removeItems - non-null items to remove from the filter, defaults to empty array

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest