Package com.google.api.core

Annotation Type ObsoleteApi

@BetaApi @Retention(RUNTIME) @Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,METHOD,PACKAGE,TYPE}) @Documented public @interface ObsoleteApi
Indicates a public API is obsolete, and will be deprecated in a future version.

Usage guidelines:

  1. This annotation must be used only on APIs with non-private visibility.
  2. This annotation should only be added if either an alternative API is provided and/or we plan to stop supporting the API in a future version.
  3. This annotation must be used with a description.
  4. Alternative APIs must be referenced in Javadoc and/or description if possible.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Context information such as reasons and alternatives.

  • Element Details

    • value

      String value
      Context information such as reasons and alternatives.