com.alibaba.nacos.api.config.annotation

Annotation Type NacosConfigListener

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Documented
public @interface NacosConfigListener

Annotation that marks a method as a listener for Nacos Config change.

Since:

0.2.0

Author:

Mercy

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	dataId Nacos Data ID

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends NacosConfigConverter>	converter Specify Nacos configuraion convertor class to convert target type instance.
String	groupId Nacos Group ID
NacosProperties	properties The NacosProperties attribute, If not specified, it will use global Nacos Properties.
long	timeout Maximum timeout value of execution in milliseconds, which is used to prevent long-time blocking execution impacting others.
ConfigType	type Nacos Config type

Element Detail

dataId

public abstract String dataId

Nacos Data ID

Returns:

required value.

groupId

public abstract String groupId

Nacos Group ID

Returns:

default value Constants.DEFAULT_GROUP;

Default:

"DEFAULT_GROUP"

type

public abstract ConfigType type

Nacos Config type

Returns:

"properties"

Default:

com.alibaba.nacos.api.config.ConfigType.PROPERTIES

converter

public abstract Class<? extends NacosConfigConverter> converter

Specify Nacos configuraion convertor class to convert target type instance.

Returns:

The implementation class of NacosConfigConverter

Default:

com.alibaba.nacos.api.config.convert.NacosConfigConverter.class

properties

public abstract NacosProperties properties

The NacosProperties attribute, If not specified, it will use global Nacos Properties.

Returns:

the default value is NacosProperties

Default:

@com.alibaba.nacos.api.annotation.NacosProperties

timeout

public abstract long timeout

Maximum timeout value of execution in milliseconds, which is used to prevent long-time blocking execution impacting others.

Returns:

default value is 1000

Default:

1000L