Package org.apache.camel.spi

Annotation Interface ApiParams

@Retention(RUNTIME) @Documented @Target(TYPE) public @interface ApiParams
Used to annotate a nested configuration parameter type (such as a nested Configuration object) which can then be used on a API based component, endpoint. This is only applicable for API based components where configurations are separated by API names and methods (grouping).

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    ApiMethod[]
    apiMethods
    The API methods that the API provides of this configuration class.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    aliases
    Returns the method alias(s) of this api method.
    String
    apiName
    The API name (grouping) of this configuration class.
    boolean
    consumerOnly
    Whether this API can only be used as a consumer.
    String
    description
    Returns a description of the API.
    boolean
    producerOnly
    Whether this API can only be used as a producer.

  • Element Details

    • apiMethods

      ApiMethod[] apiMethods
      The API methods that the API provides of this configuration class.

    • apiName

      String apiName
      The API name (grouping) of this configuration class.
      Default:
      ""

    • description

      String description
      Returns a description of the API.

      This is used for documentation and tooling only.

      Default:
      ""

    • producerOnly

      boolean producerOnly
      Whether this API can only be used as a producer.

      By default its assumed the API can be used as both consumer and producer.

      Default:
      false

    • consumerOnly

      boolean consumerOnly
      Whether this API can only be used as a consumer.

      By default its assumed the API can be used as both consumer and producer.

      Default:
      false

    • aliases

      String[] aliases
      Returns the method alias(s) of this api method. The syntax for an alias is pattern=name where pattern is a regular expression.

      This is used for documentation and tooling only.

      Default:
      {""}