Package co.elastic.clients.json

Interface JsonEnum

All Superinterfaces:
JsonpSerializable
All Known Implementing Classes:
AccessTokenGrantType, AcknowledgementOptions, Action.Kind, ActionExecutionMode, ActionStatusOptions, ActionType, Aggregate.Kind, Aggregation.Kind, AllocationExplainDecision, Analyzer.Kind, ApiKeyGrantType, AppliesTo, BoundaryScanner, BuiltinHighlighterType, BulkOperation.Kind, Bytes, CalendarInterval, CatAnomalyDetectorColumn, CatDatafeedColumn, CatDfaColumn, CategorizationStatus, CatTrainedModelsColumn, CatTransformColumn, CharFilterDefinition.Kind, ChildScoreMode, ChunkingMode, ClusterPrivilege, ClusterRemoteInfo.Kind, CombinedFieldsOperator, CombinedFieldsZeroTerms, Condition.Kind, ConditionOperator, ConditionType, Conflicts, ConnectionScheme, ConvertType, DatafeedState, DataframeAnalysis.Kind, DataframeAnalysisFeatureProcessor.Kind, DataframeAnalyticsStats.Kind, DataframeEvaluation.Kind, DataframeState, Day, Decision, DelimitedPayloadEncoding, DeprecationLevel, DistanceUnit, DynamicMapping, EdgeNGramSide, EnrichPolicyPhase, ExcludeFrequent, ExecutionPhase, ExecutionStatus, ExpandWildcard, FieldRule.Kind, FieldSortNumericType, FieldSuggester.Kind, FieldType, FieldValueFactorModifier, FilterType, FollowerIndexStatus, FunctionBoostMode, FunctionScore.Kind, FunctionScoreMode, GapPolicy, GeoDistanceType, GeoExecution, GeoOrientation, GeoShapeRelation, GeoStrategy, GeoValidationMethod, GroupBy, HealthStatus, HighlighterEncoder, HighlighterFragmenter, HighlighterOrder, HighlighterTagsSchema, HoltWintersType, HttpInputMethod, IcuCollationAlternate, IcuCollationCaseFirst, IcuCollationDecomposition, IcuCollationStrength, IcuNormalizationMode, IcuNormalizationType, IcuTransformDirection, Include, IndexCheckOnStartup, IndexingJobState, IndexOptions, IndexPrivilege, IndexRoutingAllocationOptions, IndexRoutingRebalanceOptions, IndicesBlockOptions, Input.Kind, InputType, Intervals.Kind, IntervalsFilter.Kind, IntervalsQuery.Kind, JobBlockedReason, JobState, KeepTypesMode, KuromojiTokenizationMode, Language, Level, LicenseStatus, LicenseType, LifecycleExplain.Kind, LifecycleOperationMode, MatchType, MemoryStatus, Metric, MigrationStatus, MinimumInterval, MissingOrder, Month, MovingAverageAggregation.Kind, MultiValueMode, NodeRole, NoriDecompoundMode, NormalizeMethod, Normalizer.Kind, NumericFielddataFormat, OnScriptError, OperationType, Operator, OpType, PagerDutyContextType, PagerDutyEventType, PhoneticEncoder, PhoneticLanguage, PhoneticNameType, PhoneticRuleType, PinnedQuery.Kind, PivotGroupBy.Kind, Preprocessor.Kind, Processor.Kind, Property.Kind, Quantifier, Query.Kind, RangeRelation, RateMode, Refresh, ResponseContentType, Result, ResultPosition, RetentionPolicy.Kind, RoleMappingRule.Kind, RuleAction, RuntimeFieldType, SamplerAggregationExecutionHint, Schedule.Kind, ScoreMode, ScriptSortType, SearchType, SegmentSortMissing, SegmentSortMode, SegmentSortOrder, ShapeType, ShardRoutingState, ShardsStatsStage, ShardStoreAllocation, ShardStoreStatus, ShutdownStatus, ShutdownType, SimpleQueryStringFlag, SlicesCalculation, SmoothingModel.Kind, SnapshotSort, SnapshotUpgradeState, SnowballLanguage, SortMode, SortOptions.Kind, SortOrder, SpanQuery.Kind, StatsLevel, StorageType, StringDistance, Suggestion.Kind, SuggestMode, SuggestSort, Sync.Kind, SynonymFormat, TemplateFormat, TermsAggregationCollectMode, TermsAggregationExecutionHint, TermVectorOption, TextQueryType, ThreadPoolSize, ThreadType, TimeUnit, TokenChar, TokenFilterDefinition.Kind, TokenizerDefinition.Kind, TotalHitsRelation, Transform.Kind, TranslogDurability, Trigger.Kind, TriggerEvent.Kind, TTestType, UnassignedInformationReason, UserAgentProperty, ValueType, VersionType, WaitForActiveShardOptions, WaitForEvents, WatcherMetric, WatcherState, 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.

  • 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 Details

    • 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