Documentation
¶
Index ¶
- Constants
- func OverrideServiceUrl(url string)
- type AppConfiguration
- func (ac *AppConfiguration) EnableDebug(enabled bool)
- func (ac *AppConfiguration) FetchConfigurations()
- func (ac *AppConfiguration) GetFeature(featureID string) (models.Feature, error)
- func (ac *AppConfiguration) GetFeatures() (map[string]models.Feature, error)
- func (ac *AppConfiguration) GetProperties() (map[string]models.Property, error)
- func (ac *AppConfiguration) GetProperty(propertyID string) (models.Property, error)
- func (ac *AppConfiguration) GetSecret(propertyID string, secretsManagerService *sm.SecretsManagerV2) (models.SecretProperty, error)
- func (ac *AppConfiguration) Init(region string, guid string, apikey string)
- func (ac *AppConfiguration) RegisterConfigurationUpdateListener(fhl configurationUpdateListenerFunc)
- func (ac *AppConfiguration) SetContext(collectionID string, environmentID string, options ...ContextOptions)
- func (ac *AppConfiguration) UsePrivateEndpoint(usePrivateEndpointParam bool)
- type ConfigurationHandler
- type ContextOptions
Constants ¶
const REGION_AU_SYD = "au-syd"
REGION_AU_SYD : Sydney Region
const REGION_EU_DE = "eu-de"
REGION_EU_DE : Frankfurt Region
const REGION_EU_GB = "eu-gb"
REGION_EU_GB : London Region
const REGION_US_EAST = "us-east"
REGION_US_EAST : Washington DC Region
const REGION_US_SOUTH = "us-south"
REGION_US_SOUTH : Dallas Region
Variables ¶
This section is empty.
Functions ¶
func OverrideServiceUrl ¶ added in v0.3.0
func OverrideServiceUrl(url string)
OverrideServiceUrl method overrides the default App Configuration URL. This method should be invoked before the SDK initialization.
Example: AppConfiguration.OverrideServiceUrl("https://testurl.com")
NOTE: To be used for development purposes only.
Types ¶
type AppConfiguration ¶
type AppConfiguration struct {
// contains filtered or unexported fields
}
AppConfiguration : Struct having init and configInstance.
func GetInstance ¶
func GetInstance() *AppConfiguration
GetInstance : Get App Configuration Instance
func (*AppConfiguration) EnableDebug ¶
func (ac *AppConfiguration) EnableDebug(enabled bool)
EnableDebug : Enable Debug
func (*AppConfiguration) FetchConfigurations ¶
func (ac *AppConfiguration) FetchConfigurations()
FetchConfigurations : Fetch Configurations
func (*AppConfiguration) GetFeature ¶
func (ac *AppConfiguration) GetFeature(featureID string) (models.Feature, error)
GetFeature : Get Feature
func (*AppConfiguration) GetFeatures ¶
func (ac *AppConfiguration) GetFeatures() (map[string]models.Feature, error)
GetFeatures : Get Features
func (*AppConfiguration) GetProperties ¶
func (ac *AppConfiguration) GetProperties() (map[string]models.Property, error)
GetProperties : Get Properties
func (*AppConfiguration) GetProperty ¶
func (ac *AppConfiguration) GetProperty(propertyID string) (models.Property, error)
GetProperty : Get Property
func (*AppConfiguration) GetSecret ¶ added in v0.3.1
func (ac *AppConfiguration) GetSecret(propertyID string, secretsManagerService *sm.SecretsManagerV2) (models.SecretProperty, error)
GetSecret : Get Secret
func (*AppConfiguration) Init ¶
func (ac *AppConfiguration) Init(region string, guid string, apikey string)
Init : Init App Configuration Instance
func (*AppConfiguration) RegisterConfigurationUpdateListener ¶
func (ac *AppConfiguration) RegisterConfigurationUpdateListener(fhl configurationUpdateListenerFunc)
RegisterConfigurationUpdateListener : Register Configuration Update Listener
func (*AppConfiguration) SetContext ¶
func (ac *AppConfiguration) SetContext(collectionID string, environmentID string, options ...ContextOptions)
SetContext : Set Context
func (*AppConfiguration) UsePrivateEndpoint ¶ added in v0.3.2
func (ac *AppConfiguration) UsePrivateEndpoint(usePrivateEndpointParam bool)
UsePrivateEndpoint : Use this method to set the SDK to connect to App Configuration service by using a private endpoint that is accessible only through the IBM Cloud private network. Be default, it is set to false.
NOTE: This method must be called before calling the `Init` function on the SDK.
type ConfigurationHandler ¶
type ConfigurationHandler struct {
// contains filtered or unexported fields
}
ConfigurationHandler : Configuration Handler
func GetConfigurationHandlerInstance ¶
func GetConfigurationHandlerInstance() *ConfigurationHandler
GetConfigurationHandlerInstance : Get Configuration Handler Instance
func (*ConfigurationHandler) FetchConfigurationData ¶
func (ch *ConfigurationHandler) FetchConfigurationData()
FetchConfigurationData : Fetch Configuration Data
func (*ConfigurationHandler) Init ¶
func (ch *ConfigurationHandler) Init(region, guid, apikey string, usePrivateEndpoint bool)
Init : Init App Configuration Instance
func (*ConfigurationHandler) SetContext ¶
func (ch *ConfigurationHandler) SetContext(collectionID, environmentID string, options ContextOptions)
SetContext : Set Context
type ContextOptions ¶
type ContextOptions struct {
PersistentCacheDirectory string
BootstrapFile string
LiveConfigUpdateEnabled bool
}
ContextOptions : Struct having PersistentCacheDirectory path, BootstrapFile (ConfigurationFile) path and LiveConfigUpdateEnabled flag.
Source Files
Directories