Package com.inductiveautomation.ignition.gateway.storeforward.strategy

Enum Class StorageForwardingPolicy

java.lang.Object

java.lang.Enum<StorageForwardingPolicy>

com.inductiveautomation.ignition.gateway.storeforward.strategy.StorageForwardingPolicy

All Implemented Interfaces:

Serializable, Comparable<StorageForwardingPolicy>, Constable

public enum StorageForwardingPolicy
extends Enum<StorageForwardingPolicy>

An enumeration that represents the storage forwarding policy.

This is used for determining where a store and forward engine should forward data from when storing to the final data sink.

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
ALL	Forward data from either primary or secondary.
PRIMARY_ONLY	Only forward data from primary.
SECONDARY_ONLY	Only forward data from secondary.

Method Summary

Modifier and Type	Method	Description
static Optional<StorageForwardingPolicy>	fromString(String text)	Converts a string representation of the storage forwarding policy to its enum value.
boolean	isSecondaryForwarding()	Returns whether the policy specifies that forwarding can occur from the secondary.
boolean	onlyForwardFromSecondary()	Slightly different from isSecondaryForwarding() in that this returns whether the policy specifies that forwarding can only occur from the secondary.
static StorageForwardingPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StorageForwardingPolicy[]	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

ALL

public static final StorageForwardingPolicy ALL

Forward data from either primary or secondary.

PRIMARY_ONLY

public static final StorageForwardingPolicy PRIMARY_ONLY

Only forward data from primary.

SECONDARY_ONLY

public static final StorageForwardingPolicy SECONDARY_ONLY

Only forward data from secondary.

Method Details

values

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

isSecondaryForwarding

public boolean isSecondaryForwarding()

Returns whether the policy specifies that forwarding can occur from the secondary.

onlyForwardFromSecondary

public boolean onlyForwardFromSecondary()

Slightly different from isSecondaryForwarding() in that this returns whether the policy specifies that forwarding can only occur from the secondary.

fromString

public static Optional<StorageForwardingPolicy> fromString(String text)

Converts a string representation of the storage forwarding policy to its enum value.

Parameters:

text - the string representation of the storage forwarding policy.

Returns:

an Optional containing the storage forwarding policy, or empty if the input is null or not recognized.