Enum IndexActionType

java.lang.Object

java.lang.Enum<IndexActionType>

com.azure.search.documents.models.IndexActionType

All Implemented Interfaces:

Serializable, Comparable<IndexActionType>, java.lang.constant.Constable

public enum IndexActionType
extends Enum<IndexActionType>

The operation to perform on a document in an indexing batch.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETE	Removes the specified document from the index.
MERGE	Merges the specified field values with an existing document.
MERGE_OR_UPLOAD	Behaves like merge if a document with the given key already exists in the index.
UPLOAD	Inserts the document into the index if it is new and updates it if it exists.

Method Summary

Modifier and Type	Method	Description
static IndexActionType	fromString(String value)	Parses a serialized value to a IndexActionType instance.
String	toString()
static IndexActionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexActionType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UPLOAD

public static final IndexActionType UPLOAD

Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case.

MERGE

public static final IndexActionType MERGE

Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types.

MERGE_OR_UPLOAD

public static final IndexActionType MERGE_OR_UPLOAD

Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document.

DELETE

public static final IndexActionType DELETE

Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null.

Method Details

values

public static IndexActionType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IndexActionType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static IndexActionType fromString(String value)

Parses a serialized value to a IndexActionType instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed IndexActionType object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<IndexActionType>