Package org.apache.pulsar.common.policies.data

Enum Class SchemaAutoUpdateCompatibilityStrategy

java.lang.Object

java.lang.Enum<SchemaAutoUpdateCompatibilityStrategy>

org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy

All Implemented Interfaces:

Serializable, Comparable<SchemaAutoUpdateCompatibilityStrategy>, Constable

public enum SchemaAutoUpdateCompatibilityStrategy
extends Enum<SchemaAutoUpdateCompatibilityStrategy>

Strategy to use when checking an auto-updated schema for compatibility to the current schema.

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
AlwaysCompatible	Always Compatible - The new schema will not be checked for compatibility against old schemas.
AutoUpdateDisabled	Don't allow any auto updates.
Backward	Messages written in the previous schema can be read by the new schema.
BackwardTransitive	Be similar to Backward.
Forward	Messages written in the new schema can be read by the previous schema.
ForwardTransitive	Be similar to Forward, ForwardTransitive ensure new schema can be ready by all previous version schema.
Full	Backward and Forward.
FullTransitive	BackwardTransitive and ForwardTransitive.

Method Summary

Modifier and Type	Method	Description
static SchemaAutoUpdateCompatibilityStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SchemaAutoUpdateCompatibilityStrategy[]	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

AutoUpdateDisabled

public static final SchemaAutoUpdateCompatibilityStrategy AutoUpdateDisabled

Don't allow any auto updates.

Backward

public static final SchemaAutoUpdateCompatibilityStrategy Backward

Messages written in the previous schema can be read by the new schema. To be backward compatible, the new schema must not add any new fields that don't have default values. However, it may remove fields.

Forward

public static final SchemaAutoUpdateCompatibilityStrategy Forward

Messages written in the new schema can be read by the previous schema. To be forward compatible, the new schema must not remove any fields which don't have default values in the previous schema. However, it may add new fields.

Full

public static final SchemaAutoUpdateCompatibilityStrategy Full

Backward and Forward.

AlwaysCompatible

public static final SchemaAutoUpdateCompatibilityStrategy AlwaysCompatible

Always Compatible - The new schema will not be checked for compatibility against old schemas. In other words, new schemas will always be marked assumed compatible.

BackwardTransitive

public static final SchemaAutoUpdateCompatibilityStrategy BackwardTransitive

Be similar to Backward. BackwardTransitive ensure all previous version schema can be read by the new schema.

ForwardTransitive

public static final SchemaAutoUpdateCompatibilityStrategy ForwardTransitive

Be similar to Forward, ForwardTransitive ensure new schema can be ready by all previous version schema.

FullTransitive

public static final SchemaAutoUpdateCompatibilityStrategy FullTransitive

BackwardTransitive and ForwardTransitive.

Method Details

values

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