Package com.azure.search.documents.indexes.models

Class MarkdownHeaderDepth

java.lang.Object
com.azure.core.util.ExpandableStringEnum<MarkdownHeaderDepth>
com.azure.search.documents.indexes.models.MarkdownHeaderDepth
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public final class MarkdownHeaderDepth extends com.azure.core.util.ExpandableStringEnum<MarkdownHeaderDepth>
Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final MarkdownHeaderDepth
    H1
    Indicates that headers up to a level of h1 will be considered while grouping markdown content.
    static final MarkdownHeaderDepth
    H2
    Indicates that headers up to a level of h2 will be considered while grouping markdown content.
    static final MarkdownHeaderDepth
    H3
    Indicates that headers up to a level of h3 will be considered while grouping markdown content.
    static final MarkdownHeaderDepth
    H4
    Indicates that headers up to a level of h4 will be considered while grouping markdown content.
    static final MarkdownHeaderDepth
    H5
    Indicates that headers up to a level of h5 will be considered while grouping markdown content.
    static final MarkdownHeaderDepth
    H6
    Indicates that headers up to a level of h6 will be considered while grouping markdown content.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MarkdownHeaderDepth()
    Deprecated.
    Use the fromString(String) factory method.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MarkdownHeaderDepth
    fromString(String name)
    Creates or finds a MarkdownHeaderDepth from its string representation.
    static Collection<MarkdownHeaderDepth>
    values()
    Gets known MarkdownHeaderDepth values.

    Methods inherited from class com.azure.core.util.ExpandableStringEnum

    equals, fromString, getValue, hashCode, toString, values

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • H1

      public static final MarkdownHeaderDepth H1
      Indicates that headers up to a level of h1 will be considered while grouping markdown content.

    • H2

      public static final MarkdownHeaderDepth H2
      Indicates that headers up to a level of h2 will be considered while grouping markdown content.

    • H3

      public static final MarkdownHeaderDepth H3
      Indicates that headers up to a level of h3 will be considered while grouping markdown content.

    • H4

      public static final MarkdownHeaderDepth H4
      Indicates that headers up to a level of h4 will be considered while grouping markdown content.

    • H5

      public static final MarkdownHeaderDepth H5
      Indicates that headers up to a level of h5 will be considered while grouping markdown content.

    • H6

      public static final MarkdownHeaderDepth H6
      Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default.

  • Constructor Details

    • MarkdownHeaderDepth

      @Deprecated public MarkdownHeaderDepth()
      Deprecated.
      Use the fromString(String) factory method.
      Creates a new instance of MarkdownHeaderDepth value.

  • Method Details

    • fromString

      public static MarkdownHeaderDepth fromString(String name)
      Creates or finds a MarkdownHeaderDepth from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding MarkdownHeaderDepth.

    • values

      public static Collection<MarkdownHeaderDepth> values()
      Gets known MarkdownHeaderDepth values.
      Returns:
      known MarkdownHeaderDepth values.