Package org.apache.pulsar.io.core.annotations

Annotation Interface FieldDoc

@Public @Stable @Retention(RUNTIME) @Target(FIELD) public @interface FieldDoc
Annotation for documenting fields in a config.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    defaultValue
    Return the value of this field.
    String
    help
    Return the description of this field.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    required
    Return if the field is required or not.
    boolean
    sensitive
    Return if the field is a sensitive type or not.

  • Element Details

    • defaultValue

      String defaultValue
      Return the value of this field.
      Returns:
      the default value of this field

    • help

      String help
      Return the description of this field.
      Returns:
      the help message of this field

    • required

      boolean required
      Return if the field is required or not.
      Returns:
      true if the field is required, otherwise false
      Default:
      false

    • sensitive

      boolean sensitive
      Return if the field is a sensitive type or not. User name, password, access token are some examples of sensitive fields.
      Returns:
      true if the field is sensitive, otherwise false
      Default:
      false