Annotation Type ConnectorAttribute
-
@Retention(CLASS) @Target(TYPE) @Repeatable(ConnectorAttributes.class) public @interface ConnectorAttribute
Connector implementor can use this annotation to document attributes supported by their connector. This allows tools (IDE, annotation processors...) to extract that data to provide code completion or documentation generation. Each attribute is represented by an instance ofConnectorAttribute
. For example:@ConnectorAttribute(name = "bootstrap.servers", alias = "kafka.bootstrap.servers", type = "string", defaultValue = "localhost:9092", direction = Direction.INCOMING_AND_OUTGOING, description = "...") @ConnectorAttribute(name = "topic", type = "string", direction = Direction.INCOMING_AND_OUTGOING, description = "...") @ConnectorAttribute(name = "value-deserialization-failure-handler", type = "string", direction = Direction.INCOMING, description = "...") @ConnectorAttribute(name = "merge", direction = OUTGOING, type = "boolean", defaultValue = "false", description = "...") @Connector("my-connector") public class MyConnector implements IncomingConnectorFactory, OutgoingConnectorFactory { ... }
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description String
description
ConnectorAttribute.Direction
direction
String
name
String
type
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
alias
String
defaultValue
boolean
deprecated
boolean
hidden
boolean
mandatory
-
-
-
Field Detail
-
NO_VALUE
static final String NO_VALUE
The constant used to indicate that the attribute has no default value or no alias.
-
-
Element Detail
-
name
String name
- Returns:
- the attribute name, must not be
null
, must not beblank
, must be unique for a specific connector
-
-
-
description
String description
- Returns:
- the description of the attribute.
-
-
-
direction
ConnectorAttribute.Direction direction
- Returns:
- on which direction the attribute is used.
-
-
-
type
String type
- Returns:
- the java type of the property.
-
-
hidden
boolean hidden
- Returns:
- whether the attribute must be hidden.
- Default:
- false
-
-
-
defaultValue
String defaultValue
- Returns:
- the default value if any.
- Default:
- "<no-value>"
-
-
-
alias
String alias
- Returns:
- the optional MicroProfile Config property used to configure the attribute.
- Default:
- "<no-value>"
-
-