Annotation Type ConnectorAttribute
-
@Retention(CLASS) @Target(TYPE) @Repeatable(ConnectorAttributes.class) public @interface ConnectorAttribute
Annotation used to declare an attribute on the connector.
-
-
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
hiddenFromDocumentation
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.
-
-
hiddenFromDocumentation
boolean hiddenFromDocumentation
- Returns:
- whether the attribute must be hidden from the documentation.
- 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>"
-
-