Package com.datastax.astra.client.model

Enum ReturnDocument

java.lang.Object

java.lang.Enum<ReturnDocument>

com.datastax.astra.client.model.ReturnDocument

All Implemented Interfaces:

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

public enum ReturnDocument
extends Enum<ReturnDocument>

Enum to define the return document option.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER	if set to after, the command will return the document after the update
BEFORE	if set to before, the command will return the document before the update

Method Summary

Modifier and Type	Method	Description
static ReturnDocument	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReturnDocument[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BEFORE

public static final ReturnDocument BEFORE

if set to before, the command will return the document before the update

AFTER

public static final ReturnDocument AFTER

if set to after, the command will return the document after the update

Method Details

values

public static ReturnDocument[] 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 ReturnDocument 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