Package org.opensearch.client.json

Interface JsonEnum

All Superinterfaces:
JsonpSerializable
All Known Implementing Classes:
Action.Kind, ActionStatusOptions, ActionStatusOptions, Aggregate.Kind, Aggregation.Kind, AllocationExplainDecision, Analyzer.Kind, BoundaryScanner, BuiltinHighlighterType, BuiltinScriptLanguage, BuiltinStorageType, BulkOperation.Kind, Bytes, CalendarInterval, CardinalityExecutionMode, CharFilterDefinition.Kind, ChildScoreMode, ClusterHealthLevel, ClusterRemoteInfo.Kind, ClusterRerouteMetric, ClusterStateMetric, CombinedFieldsOperator, CombinedFieldsZeroTerms, Conflicts, ConvertType, DataSourceState, Decision, DecommissionStatus, DeletionResult, DelimitedPayloadEncoding, DFIIndependenceMeasure, DFRAfterEffect, DFRBasicModel, DistanceUnit, DynamicMapping, EdgeNGramSide, ErrorPolicy, ExpandWildcard, FieldSortNumericType, FieldSuggester.Kind, FieldType, FieldValueFactorModifier, FunctionBoostMode, FunctionName, FunctionScore.Kind, FunctionScoreMode, GapPolicy, GeoDistanceType, GeoExecution, GeoJSONDataType, GeoOrientation, GeoShapeRelation, GeospatialFieldType, GeoStrategy, GeoValidationMethod, GroupBy, HealthStatus, HighlighterEncoder, HighlighterFragmenter, HighlighterOrder, HighlighterTagsSchema, HoltWintersType, IBDistribution, IBLambda, IcuCollationAlternate, IcuCollationCaseFirst, IcuCollationDecomposition, IcuCollationStrength, IcuNormalizationMode, IcuNormalizationType, IcuTransformDirection, IndexCheckOnStartup, IndexMetric, IndexOptions, IndexRoutingAllocationOptions, IndexRoutingRebalanceOptions, IndexSettingsMergePolicyName, IndexSettingsStoreFsLock, IndicesBlockOptions, IndicesStatsMetric, IngestionSourcePointerInitReset, IngestionSourceType, Intervals.Kind, IntervalsFilter.Kind, IntervalsQuery.Kind, JsonProcessorConflictStrategy, KeepTypesMode, KnnStatName, KuromojiTokenizationMode, Language, Level, LifecycleOperationMode, LtrStatName, ManagedBy, MatchType, Metric, MinimumInterval, MissingOrder, ModelFormat, MovingAverageAggregation.Kind, MultiValueMode, NodeRole, NodesInfoMetric, NodesStatsIndexMetric, NodesStatsMetric, NodesUsageMetric, NoriDecompoundMode, NormalizeMethod, Normalizer.Kind, NumericFielddataFormat, OperationType, Operator, OpType, PhaseResultsProcessor.Kind, PhoneticEncoder, PhoneticLanguage, PhoneticNameType, PhoneticRuleType, PinnedQuery.Kind, PollerState, Processor.Kind, Property.Kind, Query.Kind, RateMode, Refresh, ReplicationType, RequestProcessor.Kind, ResetMode, ResponseProcessor.Kind, Result, RuntimeFieldType, SamplerAggregationExecutionHint, ScoreCombinationTechnique, ScoreMode, ScoreNormalizationTechnique, ScoreRankerCombinationTechnique, ScriptSortType, SearchType, SegmentSortMissing, SegmentSortMode, SegmentSortOrder, ShapeType, ShardRoutingState, ShardSearchBackpressureMode, ShardStoreAllocation, ShardStoreStatus, SimpleQueryStringFlag, SlicesCalculation, SmoothingModel.Kind, SnapshotShardsStatsStage, SnowballLanguage, SortMode, SortOptions.Kind, SortOrder, SpanQuery.Kind, Status, StringDistance, SuggestMode, SuggestSort, SynonymFormat, TermFrequencyNormalization, TermsAggregationCollectMode, TermsAggregationExecutionHint, TermsQueryValueType, TermVectorOption, TextQueryType, ThreadType, TimeUnit, TokenChar, TokenFilterDefinition.Kind, TokenizerDefinition.Kind, TotalHitsRelation, TranslogDurability, 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 String[]
    aliases()
     
    String
    jsonValue()
     
    default void
    serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper params)
     

  • Method Details