Package io.camunda.zeebe.client.api

Annotation Type ExperimentalApi

@Retention(CLASS) @Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,METHOD,PACKAGE,TYPE}) @Documented public @interface ExperimentalApi
Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility. If users want stabilization or signature change of a specific API that is currently annotated @ExperimentalApi, please comment on its tracking issue on github with rationale, usecase, and so forth, so that the Zeebe team may prioritize the process toward stabilization of the API.

Usage guidelines:

  1. This annotation is used only on public API. Internal interfaces should not use it.
  2. After Zeebe has gained API stability, this annotation can only be added to new API. Adding it to an existing API is considered API-breaking.
  3. Removing this annotation from an API gives it stable status.

Note: This annotation is intended only for Zeebe library code. Users should not attach this annotation to their own code.

This annotation was originally copied from io.grpc.ExperimentalApi, licensed under the Apache License, Version 2.0. Copyright 2015 The gRPC Authors. Changes have been made since.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Context information such as links to discussion thread, tracking issue etc.

  • Element Details

    • value

      String value
      Context information such as links to discussion thread, tracking issue etc.