Package org.opensearch.common.annotation

Annotation Type DeprecatedApi

@Documented @Target({TYPE,PACKAGE,METHOD,CONSTRUCTOR,PARAMETER,FIELD,ANNOTATION_TYPE,MODULE}) @PublicApi(since="2.10.0") public @interface DeprecatedApi
Marks the public APIs as deprecated and scheduled for removal in one of the upcoming major releases. The types marked with this annotations could only be other PublicApis.
Opensearch.api:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    since
    Version since this API is deprecated

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    forRemoval
    Next major version when this API is scheduled for removal

  • Element Details

    • since

      String since
      Version since this API is deprecated

    • forRemoval

      String forRemoval
      Next major version when this API is scheduled for removal
      Default:
      ""