Annotation Type SdkProtectedApi


  • @Documented
    @Target({PACKAGE,TYPE,FIELD,CONSTRUCTOR,METHOD})
    @SdkProtectedApi
    public @interface SdkProtectedApi
    Marks APIs that should not be used by SDK users and are intended for SDK internal classes shared across different modules.

    IMPORTANT: Elements annotated with @SdkProtectedApi must maintain backward compatibility. Breaking changes will break older versions of generated clients, even if they don't directly impact SDK users.

    Intended for: Generated service clients and internal SDK modules that support them. These APIs form the contract between the SDK core and generated code.

    Stability guarantee: Protected APIs should not introduce breaking changes, as this would require regenerating and redeploying all service clients.

    See Also:
    SdkInternalApi, SdkPublicApi