org.apache.samza.operators

Enum UpdateOptions

java.lang.Object

java.lang.Enum<UpdateOptions>

org.apache.samza.operators.UpdateOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UpdateOptions>

public enum UpdateOptions
extends java.lang.Enum<UpdateOptions>

This class defines the update contract used in the send-to-table-with-update operator. It tells the operator whether to perform just updates or updates with defaults.

Enum Constant Summary

Enum Constants

Enum Constant and Description
UPDATE_ONLY Indicates that the sendTo operator will only perform an Update operation for the given key.
UPDATE_WITH_DEFAULTS Indicates that the sendTo operator will first apply an update for the given key.

Method Summary

Modifier and Type	Method and Description
static UpdateOptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UpdateOptions[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UPDATE_ONLY

public static final UpdateOptions UPDATE_ONLY

Indicates that the sendTo operator will only perform an Update operation for the given key.

UPDATE_WITH_DEFAULTS

public static final UpdateOptions UPDATE_WITH_DEFAULTS

Indicates that the sendTo operator will first apply an update for the given key. If the update fails due to the record not being present for the key, operator will attempt to Put a default and then apply an update. The following conditions need to be true for this to occur: 1) User should provide a default value using UpdateMessage.of(Object, Object) 2) The Table Integration should throw a RecordNotFoundException when update fails due to no record being found for the key. Put a default can fail due to an exception due to various reasons- server error, failed conditional put (failed Put if record already inserted by another process). An update will be re-attempted regardless of the result of the Put default operation.

Method Detail

values

public static UpdateOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UpdateOptions c : UpdateOptions.values())
    System.out.println(c);

Returns:

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

valueOf

public static UpdateOptions valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null