com.alibaba.nacos.api.config.annotation

Annotation Type NacosConfigurationProperties

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface NacosConfigurationProperties

An annotation for Nacos configuration Properties for binding POJO as Properties Object.

Since:

0.2.0

Author:

Mercy

See Also:

PropertyKeyConst

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
boolean	autoRefreshed It indicates the properties of current doBind bean is auto-refreshed when Nacos configuration is changed.
boolean	exceptionIfInvalid Flag to indicate that an exception should be raised if a Validator is available and validation fails.
String	groupId Nacos Group ID
boolean	ignoreInvalidFields Flag to indicate that when binding to this object invalid fields should be ignored.
boolean	ignoreNestedProperties Flag to indicate that when binding to this object fields with periods in their names should be ignored.
boolean	ignoreUnknownFields Flag to indicate that when binding to this object unknown fields should be ignored.
String	prefix config prefix name
NacosProperties	properties The NacosProperties attribute, If not specified, it will use global Nacos Properties.
ConfigType	type config style
boolean	yaml Deprecated.

Element Detail

dataId

public abstract String dataId

Nacos Data ID

Returns:

required value.

prefix

public abstract String prefix

config prefix name

Returns:

default value is ""

Default:

""

groupId

public abstract String groupId

Nacos Group ID

Returns:

default value Constants.DEFAULT_GROUP;

Default:

"DEFAULT_GROUP"

yaml

@Deprecated
public abstract boolean yaml

Deprecated.

set config type is yaml this method is deprecated, we support you use type() to set config type

Returns:

default value false

Default:

false

type

public abstract ConfigType type

config style

Returns:

default value is ConfigType.PROPERTIES

Default:

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

autoRefreshed

public abstract boolean autoRefreshed

It indicates the properties of current doBind bean is auto-refreshed when Nacos configuration is changed.

Returns:

default value is false

Default:

false

ignoreInvalidFields

public abstract boolean ignoreInvalidFields

Flag to indicate that when binding to this object invalid fields should be ignored. Invalid means invalid according to the binder that is used, and usually this means fields of the wrong type (or that cannot be coerced into the correct type).

Returns:

the flag value (default false)

Default:

false

ignoreNestedProperties

public abstract boolean ignoreNestedProperties

Flag to indicate that when binding to this object fields with periods in their names should be ignored.

Returns:

the flag value (default false)

Default:

false

ignoreUnknownFields

public abstract boolean ignoreUnknownFields

Flag to indicate that when binding to this object unknown fields should be ignored. An unknown field could be a sign of a mistake in the Properties.

Returns:

the flag value (default true)

Default:

true

exceptionIfInvalid

public abstract boolean exceptionIfInvalid

Flag to indicate that an exception should be raised if a Validator is available and validation fails. If it is set to false, validation errors will be swallowed. They will be logged, but not propagated to the caller.

Returns:

the flag value (default true)

Default:

true

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