Package com.linkedin.venice.meta

Enum Class VersionStorageModeUpdateReason

java.lang.Object

java.lang.Enum<VersionStorageModeUpdateReason>

com.linkedin.venice.meta.VersionStorageModeUpdateReason

All Implemented Interfaces:

Serializable, Comparable<VersionStorageModeUpdateReason>, Constable

public enum VersionStorageModeUpdateReason
extends Enum<VersionStorageModeUpdateReason>

Why a per-version StorageMode update was requested. Carried as an optional parameter on the update-version-storage-mode controller API so the controller that applies the update can tell an automated fail-open apart from a manual or operational change, without callers having to encode intent in free-form strings.

Requests that omit the reason are treated as UNSPECIFIED, which keeps older clients working.

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
EXTERNAL_WRITE_FAILURE	The push job exhausted its external-storage write retries in the targeted region(s) and is failing open by downgrading those regions' version storage mode back to StorageMode.INTERNAL before end of push.
UNSPECIFIED	Default.

Method Summary

Modifier and Type	Method	Description
static VersionStorageModeUpdateReason	parseOrDefault(String value)	Parse a reason supplied over the controller API, tolerating null and blank values so that a newer client talking to an older controller — or the reverse — never fails the request over telemetry intent.
static VersionStorageModeUpdateReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VersionStorageModeUpdateReason[]	values()	Returns an array containing the constants of this enum class, 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

UNSPECIFIED

public static final VersionStorageModeUpdateReason UNSPECIFIED

Default. A manual or otherwise unattributed storage-mode change. Not alertable.

EXTERNAL_WRITE_FAILURE

public static final VersionStorageModeUpdateReason EXTERNAL_WRITE_FAILURE

The push job exhausted its external-storage write retries in the targeted region(s) and is failing open by downgrading those regions' version storage mode back to StorageMode.INTERNAL before end of push. The push still succeeds, so this is the only signal that the region lost its external-storage copy, and the controller applying it emits an alertable metric.

Method Details

values

public static VersionStorageModeUpdateReason[] values()

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

Returns:

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

valueOf

public static VersionStorageModeUpdateReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

parseOrDefault

public static VersionStorageModeUpdateReason parseOrDefault(String value)

Parse a reason supplied over the controller API, tolerating null and blank values so that a newer client talking to an older controller — or the reverse — never fails the request over telemetry intent. An unrecognized non-blank value is logged, since it typically means a caller mis-typed the enum name and would otherwise silently lose the alertable signal this reason exists to carry.

Returns:

the matching reason, or UNSPECIFIED when the value is absent or unrecognized