Package com.azure.core.util
Class ConfigurationProperty<T>
java.lang.Object
com.azure.core.util.ConfigurationProperty<T>
- Type Parameters:
T
- Type of property value.
Represents configuration property.
-
Method Summary
Modifier and TypeMethodDescriptionGets property aliases - alternative names property can have.Gets converter for property value.Gets property default value to be used when property is missing in the configuration.Gets name of environment variables this property can be configured with.getName()
Gets full property name including relative path to it.Gets name of system property this property can be configured with.Returns property value sanitizer that is used to securely log property value.boolean
Returns true if property is required, used for validation purposes.boolean
isShared()
Returns true if property can be shared between clients andConfiguration.get(ConfigurationProperty)
should look for it in per-client and root sections.
-
Method Details
-
getValueSanitizer
Returns property value sanitizer that is used to securely log property value.- Returns:
- function that sanitizes property value.
-
isRequired
public boolean isRequired()Returns true if property is required, used for validation purposes.- Returns:
- flag indicating if the property is required.
-
getName
Gets full property name including relative path to it.- Returns:
- property name.
-
getConverter
Gets converter for property value.- Returns:
- property value converter.
-
getDefaultValue
Gets property default value to be used when property is missing in the configuration.- Returns:
- default value.
-
getAliases
Gets property aliases - alternative names property can have.- Returns:
- array of name aliases.
-
getEnvironmentVariableName
Gets name of environment variables this property can be configured with.- Returns:
- environment variable name.
-
getSystemPropertyName
Gets name of system property this property can be configured with.- Returns:
- system property name.