Package com.google.api.core

Annotation Type InternalApi

@BetaApi @Retention(RUNTIME) @Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,METHOD,PACKAGE,TYPE}) @Documented public @interface InternalApi
Annotates a program element (class, method, package etc) which is internal to its containing library, not part of the public API, and should not be used by users of the library.

This annotation only makes sense on APIs that are not private. Its existence is necessary because Java does not have a visibility level for code within a compilation unit.

Adding this annotation to an API is considered API-breaking.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Context information such as "internal to library", "for testing", etc.

  • Element Details

    • value

      String value
      Context information such as "internal to library", "for testing", etc.
      Default:
      ""