Annotation Type SimpleField

@Target({FIELD,METHOD}) @Retention(RUNTIME) public @interface SimpleField
An annotation that directs SearchIndexAsyncClient.buildSearchFields(Class, FieldBuilderOptions) to turn the field or method into a non-searchable field.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    isFacetable
    Indicates if the field or method should generate as a facetable field.
    boolean
    isFilterable
    Indicates if the field or method should generate as a filterable field.
    boolean
    isHidden
    Indicates if the field or method should generate as a hidden field.
    boolean
    isKey
    Indicates if the field or method should generate as a key field.
    boolean
    isSensitivityLabel
    Indicates if the field or method should be used for sensitivity label filtering.
    boolean
    isSortable
    Indicates if the field or method should generate as a sortable field.
    String
    normalizerName
    A LexicalNormalizerName to associate as the normalizer for the field.
    String
    permissionFilter
    A value indicating whether the field should be used as a permission filter.

  • Element Details

    • isKey

      boolean isKey
      Indicates if the field or method should generate as a key field.
      Returns:
      A flag indicating if the field or method should generate as a key field.
      Default:
      false

    • isHidden

      boolean isHidden
      Indicates if the field or method should generate as a hidden field.
      Returns:
      A flag indicating if the field or method should generate as a hidden field.
      Default:
      false

    • isFacetable

      boolean isFacetable
      Indicates if the field or method should generate as a facetable field.
      Returns:
      A flag indicating if the field or method should generate as a facetable field.
      Default:
      false

    • isSortable

      boolean isSortable
      Indicates if the field or method should generate as a sortable field.
      Returns:
      A flag indicating if the field or method should generate as a sortable field.
      Default:
      false

    • isFilterable

      boolean isFilterable
      Indicates if the field or method should generate as a filterable field.
      Returns:
      A flag indicating if the field or method should generate as a filterable field.
      Default:
      false

    • normalizerName

      String normalizerName
      A LexicalNormalizerName to associate as the normalizer for the field.
      Returns:
      The LexicalNormalizerName that will be associated as the normalizer for the field.
      Default:
      ""

    • permissionFilter

      String permissionFilter
      A value indicating whether the field should be used as a permission filter.
      Returns:
      A flag indicating if the field or method should generate as a permission filter field.
      Default:
      ""

    • isSensitivityLabel

      boolean isSensitivityLabel
      Indicates if the field or method should be used for sensitivity label filtering. This enables document-level filtering based on Microsoft Purview sensitivity labels.
      Returns:
      A flag indicating if the field or method should generate as a sensitivity label field.
      Default:
      false