com.algolia.search.inputs.partial_update

Class RemoveValueOperation

java.lang.Object

com.algolia.search.inputs.partial_update.RemoveValueOperation

All Implemented Interfaces:

PartialUpdateOperation, Serializable

public class RemoveValueOperation
extends Object
implements PartialUpdateOperation

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RemoveValueOperation(String objectID, String attributeToRemoveIn, String valueToRemove) Remove a value to an existing array, only if the value is not yet present

Method Summary

Modifier and Type	Method and Description
String	getObjectID()
Map<String,?>	toSerialize()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoveValueOperation

public RemoveValueOperation(String objectID,
                            String attributeToRemoveIn,
                            String valueToRemove)

Remove a value to an existing array, only if the value is not yet present

Parameters:

objectID - the id of the object to update

attributeToRemoveIn - the name of the attribute to remove the value

valueToRemove - the value to remove

Method Detail

getObjectID

public String getObjectID()

Specified by:

getObjectID in interface PartialUpdateOperation

toSerialize

public Map<String,?> toSerialize()

Specified by:

toSerialize in interface PartialUpdateOperation