OptionState enum

The state of processing a change to an option. One of:

• RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
• Processing: The option's latest value is in the process of being activated.
• Active: The option's latest value is fully deployed.
• FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

Inheritance

• Object
• Enum
• OptionState

Available extensions

• EnumName
• OptionStateValueExtension

Values

requiresIndexDocuments → const OptionState

processing → const OptionState

active → const OptionState

failedToValidate → const OptionState

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

toValue() → String

Available on OptionState, provided by the OptionStateValueExtension extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<OptionState>

A constant List of the values in this enum, in order of their declaration.