NacosConfigProperties (Spring Cloud Starter Alibaba Nacos Config 2.1.2.RELEASE API)

java.lang.Object
- com.alibaba.cloud.nacos.NacosConfigProperties

@ConfigurationProperties(value="spring.cloud.nacos.config")
public class NacosConfigProperties
extends Object

Nacos properties.

作者:: leijuan, xiaojing, pbting, lyuzb

嵌套类概要

嵌套类
限定符和类型类和说明

static class NacosConfigProperties.Config

嵌套类
限定符和类型	类和说明
`static class`	`NacosConfigProperties.Config`

字段概要

字段
限定符和类型字段和说明

static String COMMAS
COMMAS , .

static String PREFIX
Prefix of NacosConfigProperties.

static String SEPARATOR
SEPARATOR , .

字段
限定符和类型	字段和说明
`static String`	`COMMAS` COMMAS , .
`static String`	`PREFIX` Prefix of `NacosConfigProperties`.
`static String`	`SEPARATOR` SEPARATOR , .

构造器概要

构造器
构造器和说明

NacosConfigProperties()

构造器
构造器和说明
`NacosConfigProperties()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Properties`	`assembleConfigServiceProperties()` assemble properties for configService.
`com.alibaba.nacos.api.config.ConfigService`	`configServiceInstance()` 已过时。
`String`	`getAccessKey()`
`String`	`getClusterName()`
`String`	`getConfigLongPollTimeout()`
`String`	`getConfigRetryTime()`
`Properties`	`getConfigServiceProperties()` 已过时。
`String`	`getContextPath()`
`Boolean`	`getEnableRemoteSyncConfig()`
`String`	`getEncode()`
`String`	`getEndpoint()`
`org.springframework.core.env.Environment`	`getEnvironment()`
`List<NacosConfigProperties.Config>`	`getExtConfig()` 已过时。
`List<NacosConfigProperties.Config>`	`getExtensionConfigs()`
`String`	`getFileExtension()`
`String`	`getGroup()`
`String`	`getMaxRetry()`
`String`	`getName()`
`String`	`getNamespace()`
`String`	`getPassword()`
`String`	`getPrefix()`
`String`	`getRefreshableDataids()` 已过时。
`String`	`getSecretKey()`
`String`	`getServerAddr()`
`List<NacosConfigProperties.Config>`	`getSharedConfigs()`
`String`	`getSharedDataids()` 已过时。
`int`	`getTimeout()`
`String`	`getUsername()`
`void`	`init()`
`boolean`	`isRefreshEnabled()`
`void`	`setAccessKey(String accessKey)`
`void`	`setClusterName(String clusterName)`
`void`	`setConfigLongPollTimeout(String configLongPollTimeout)`
`void`	`setConfigRetryTime(String configRetryTime)`
`void`	`setContextPath(String contextPath)`
`void`	`setEnableRemoteSyncConfig(Boolean enableRemoteSyncConfig)`
`void`	`setEncode(String encode)`
`void`	`setEndpoint(String endpoint)`
`void`	`setEnvironment(org.springframework.core.env.Environment environment)`
`void`	`setExtConfig(List<NacosConfigProperties.Config> extConfig)` 已过时。
`void`	`setExtensionConfigs(List<NacosConfigProperties.Config> extensionConfigs)`
`void`	`setFileExtension(String fileExtension)`
`void`	`setGroup(String group)`
`void`	`setMaxRetry(String maxRetry)`
`void`	`setName(String name)`
`void`	`setNamespace(String namespace)`
`void`	`setPassword(String password)`
`void`	`setPrefix(String prefix)`
`void`	`setRefreshableDataids(String refreshableDataids)` 已过时。
`void`	`setRefreshEnabled(boolean refreshEnabled)`
`void`	`setSecretKey(String secretKey)`
`void`	`setServerAddr(String serverAddr)`
`void`	`setSharedConfigs(List<NacosConfigProperties.Config> sharedConfigs)`
`void`	`setSharedDataids(String sharedDataids)` 已过时。
`void`	`setTimeout(int timeout)`
`void`	`setUsername(String username)`
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料
- PREFIX
```
public static final String PREFIX
```
  Prefix of NacosConfigProperties.
  
  另请参阅:
  
  常量字段值
- COMMAS
```
public static final String COMMAS
```
  COMMAS , .
  
  另请参阅:
  
  常量字段值
- SEPARATOR
```
public static final String SEPARATOR
```
  SEPARATOR , .
  
  另请参阅:
  
  常量字段值

构造器详细资料
- NacosConfigProperties
```
public NacosConfigProperties()
```

方法详细资料

init
```
@PostConstruct
public void init()
```

getServerAddr
```
public String getServerAddr()
```

setServerAddr

public void setServerAddr(String serverAddr)

getUsername
```
public String getUsername()
```

setUsername

public void setUsername(String username)

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getPrefix
```
public String getPrefix()
```

setPrefix
```
public void setPrefix(String prefix)
```

getFileExtension
```
public String getFileExtension()
```

setFileExtension

public void setFileExtension(String fileExtension)

getGroup
```
public String getGroup()
```

setGroup
```
public void setGroup(String group)
```

getTimeout
```
public int getTimeout()
```

setTimeout
```
public void setTimeout(int timeout)
```

getMaxRetry
```
public String getMaxRetry()
```

setMaxRetry

public void setMaxRetry(String maxRetry)

getConfigLongPollTimeout

public String getConfigLongPollTimeout()

setConfigLongPollTimeout

public void setConfigLongPollTimeout(String configLongPollTimeout)

getConfigRetryTime
```
public String getConfigRetryTime()
```

setConfigRetryTime

public void setConfigRetryTime(String configRetryTime)

getEnableRemoteSyncConfig

public Boolean getEnableRemoteSyncConfig()

setEnableRemoteSyncConfig

public void setEnableRemoteSyncConfig(Boolean enableRemoteSyncConfig)

getEndpoint
```
public String getEndpoint()
```

setEndpoint

public void setEndpoint(String endpoint)

getNamespace
```
public String getNamespace()
```

setNamespace

public void setNamespace(String namespace)

getAccessKey
```
public String getAccessKey()
```

setAccessKey

public void setAccessKey(String accessKey)

getSecretKey
```
public String getSecretKey()
```

setSecretKey

public void setSecretKey(String secretKey)

getEncode
```
public String getEncode()
```

setEncode
```
public void setEncode(String encode)
```

getContextPath
```
public String getContextPath()
```

setContextPath

public void setContextPath(String contextPath)

getClusterName
```
public String getClusterName()
```

setClusterName

public void setClusterName(String clusterName)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getEnvironment

public org.springframework.core.env.Environment getEnvironment()

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

getSharedConfigs

public List<NacosConfigProperties.Config> getSharedConfigs()

setSharedConfigs

public void setSharedConfigs(List<NacosConfigProperties.Config> sharedConfigs)

getExtensionConfigs

public List<NacosConfigProperties.Config> getExtensionConfigs()

setExtensionConfigs

public void setExtensionConfigs(List<NacosConfigProperties.Config> extensionConfigs)

isRefreshEnabled
```
public boolean isRefreshEnabled()
```

setRefreshEnabled

public void setRefreshEnabled(boolean refreshEnabled)

getSharedDataids

@Deprecated
 @DeprecatedConfigurationProperty(reason="replaced to NacosConfigProperties#sharedConfigs and not use it at the same time.",
                                 replacement="spring.cloud.nacos.config.shared-configs[x]")
public String getSharedDataids()

已过时。

recommend to use sharedConfigs .

返回:: string

setSharedDataids
```
@Deprecated
public void setSharedDataids(String sharedDataids)
```
已过时。

recommend to use sharedConfigs and not use it at the same time .

参数:

sharedDataids - the dataids for configurable multiple shared configurations , multiple separated by commas .

getRefreshableDataids

@Deprecated
 @DeprecatedConfigurationProperty(reason="replaced to NacosConfigProperties#sharedConfigs and not use it at the same time.",
                                 replacement="spring.cloud.nacos.config.shared-configs[x].refresh")
public String getRefreshableDataids()

已过时。

Not providing support,the need to refresh is specified by the respective refresh configuration and not use it at the same time .

返回:: string

setRefreshableDataids
```
@Deprecated
public void setRefreshableDataids(String refreshableDataids)
```
已过时。

Not providing support,the need to refresh is specified by the respective refresh configuration and not use it at the same time .

参数:

refreshableDataids - refreshable dataids ,multiple separated by commas .

getExtConfig

@Deprecated
 @DeprecatedConfigurationProperty(reason="replaced to NacosConfigProperties#extensionConfigs and not use it at the same time .",
                                 replacement="spring.cloud.nacos.config.extension-configs[x]")
public List<NacosConfigProperties.Config> getExtConfig()

已过时。

recommend to use extensionConfigs and not use it at the same time .

返回:: extensionConfigs

setExtConfig

@Deprecated
public void setExtConfig(List<NacosConfigProperties.Config> extConfig)

已过时。

configServiceInstance
```
@Deprecated
public com.alibaba.nacos.api.config.ConfigService configServiceInstance()
```
已过时。

recommend to use NacosConfigManager.getConfigService().

返回:

ConfigService

getConfigServiceProperties
```
@Deprecated
public Properties getConfigServiceProperties()
```
已过时。

recommend to use assembleConfigServiceProperties().

返回:

ConfigServiceProperties

assembleConfigServiceProperties
```
public Properties assembleConfigServiceProperties()
```
assemble properties for configService. (cause by rename : Remove the interference of auto prompts when writing,because autocue is based on get method.

返回:

properties

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 NacosConfigProperties

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

PREFIX

COMMAS

SEPARATOR

构造器详细资料

NacosConfigProperties

方法详细资料

init

getServerAddr

setServerAddr

getUsername

setUsername

getPassword

setPassword

getPrefix

setPrefix

getFileExtension

setFileExtension

getGroup

setGroup

getTimeout

setTimeout

getMaxRetry

setMaxRetry

getConfigLongPollTimeout

setConfigLongPollTimeout

getConfigRetryTime

setConfigRetryTime

getEnableRemoteSyncConfig

setEnableRemoteSyncConfig

getEndpoint

setEndpoint

getNamespace

setNamespace

getAccessKey

setAccessKey

getSecretKey

setSecretKey

getEncode

setEncode

getContextPath

setContextPath

getClusterName

setClusterName

getName

setName

getEnvironment

setEnvironment

getSharedConfigs

setSharedConfigs

getExtensionConfigs

setExtensionConfigs

isRefreshEnabled

setRefreshEnabled

getSharedDataids

setSharedDataids

getRefreshableDataids

setRefreshableDataids

getExtConfig

setExtConfig

configServiceInstance

getConfigServiceProperties

assembleConfigServiceProperties

toString