io.smallrye.reactive.messaging.annotations

Annotation Type ConnectorAttribute

@Retention(value=CLASS)
 @Target(value=TYPE)
 @Repeatable(value=ConnectorAttributes.class)
public @interface ConnectorAttribute

Annotation used to declare an attribute on the connector.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NO_VALUE The constant used to indicate that the attribute has no default value or no alias.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
ConnectorAttribute.Direction	direction
String	name
String	type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	alias
String	defaultValue
boolean	deprecated
boolean	hiddenFromDocumentation
boolean	mandatory

Field Detail

NO_VALUE

public static final String NO_VALUE

The constant used to indicate that the attribute has no default value or no alias.

Element Detail

name

public abstract String name

Returns:

the attribute name, must not be null, must not be blank, must be unique for a specific connector

description

public abstract String description

Returns:

the description of the attribute.

direction

public abstract ConnectorAttribute.Direction direction

Returns:

on which direction the attribute is used.

type

public abstract String type

Returns:

the java type of the property.

hiddenFromDocumentation

public abstract boolean hiddenFromDocumentation

Returns:

whether the attribute must be hidden from the documentation.

Default:

false

mandatory

public abstract boolean mandatory

Returns:

whether the attribute is mandatory.

Default:

false

defaultValue

public abstract String defaultValue

Returns:

the default value if any.

Default:

"<no-value>"

deprecated

public abstract boolean deprecated

Returns:

whether the attribute is deprecated.

Default:

false

alias

public abstract String alias

Returns:

the optional MicroProfile Config property used to configure the attribute.

Default:

"<no-value>"