Package org.opensearch.client.json

Interface JsonEnum

All Superinterfaces:

JsonpSerializable

All Known Implementing Classes:

Action.Kind, ActionStatusOptions, Aggregate.Kind, Aggregation.Kind, AllocationExplainDecision, Analyzer.Kind, BoundaryScanner, BuiltinHighlighterType, BulkOperation.Kind, Bytes, CalendarInterval, CharFilterDefinition.Kind, ChildScoreMode, ClusterRemoteInfo.Kind, CombinedFieldsOperator, CombinedFieldsZeroTerms, Conflicts, ConvertType, Decision, DelimitedPayloadEncoding, DistanceUnit, DynamicMapping, EdgeNGramSide, ExpandWildcard, FieldSortNumericType, FieldSuggester.Kind, FieldType, FieldValueFactorModifier, FunctionBoostMode, FunctionScore.Kind, FunctionScoreMode, GapPolicy, GeoDistanceType, GeoExecution, GeoOrientation, GeoShapeRelation, GeoStrategy, GeoValidationMethod, GroupBy, HealthStatus, HighlighterEncoder, HighlighterFragmenter, HighlighterOrder, HighlighterTagsSchema, HoltWintersType, IcuCollationAlternate, IcuCollationCaseFirst, IcuCollationDecomposition, IcuCollationStrength, IcuNormalizationMode, IcuNormalizationType, IcuTransformDirection, IndexCheckOnStartup, IndexOptions, IndexRoutingAllocationOptions, IndexRoutingRebalanceOptions, IndicesBlockOptions, Intervals.Kind, IntervalsFilter.Kind, IntervalsQuery.Kind, KeepTypesMode, KuromojiTokenizationMode, Language, Level, LifecycleOperationMode, MatchType, MinimumInterval, MissingOrder, MovingAverageAggregation.Kind, MultiValueMode, NodeRole, NoriDecompoundMode, NormalizeMethod, Normalizer.Kind, NumericFielddataFormat, OnScriptError, OperationType, Operator, OpType, PhoneticEncoder, PhoneticLanguage, PhoneticNameType, PhoneticRuleType, PinnedQuery.Kind, Processor.Kind, Property.Kind, Query.Kind, RangeRelation, RateMode, Refresh, Result, RuntimeFieldType, SamplerAggregationExecutionHint, ScoreMode, ScriptSortType, SearchType, SegmentSortMissing, SegmentSortMode, SegmentSortOrder, ShapeType, ShardRoutingState, ShardsStatsStage, ShardStoreAllocation, ShardStoreStatus, ShutdownStatus, ShutdownType, SimpleQueryStringFlag, SmoothingModel.Kind, SnowballLanguage, SortMode, SortOptions.Kind, SortOrder, SpanQuery.Kind, StringDistance, SuggestMode, SuggestSort, SynonymFormat, TermsAggregationCollectMode, TermsAggregationExecutionHint, TermVectorOption, TextQueryType, ThreadPoolSize, ThreadType, TimeUnit, TokenChar, TokenFilterDefinition.Kind, TokenizerDefinition.Kind, TotalHitsRelation, TTestType, UnassignedInformationReason, UserAgentProperty, ValueType, VersionType, WaitForActiveShardOptions, WaitForEvents, ZeroTermsQuery

public interface JsonEnum
extends JsonpSerializable

Base interface for enumerations in API types. Members have a JSON representation and also accept aliases when parsed from a string value. For some enumerations primitive boolean values are also supported.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JsonEnum.Deserializer<T extends JsonEnum>

Method Summary

Modifier and Type	Method	Description
default java.lang.String[]	aliases()
java.lang.String	jsonValue()
default void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper params)

Method Detail

jsonValue

java.lang.String jsonValue()

aliases

@Nullable
default java.lang.String[] aliases()

serialize

default void serialize(jakarta.json.stream.JsonGenerator generator,
                       JsonpMapper params)

Specified by:

serialize in interface JsonpSerializable