Table 18122315 EOS004 Service Config.

Table 18122315 EOS004 Service Config.

A generic service configuration.

LanguageCaption
de-ATDienstkonfiguration
de-CHDienstkonfiguration
de-DEDienstkonfiguration
en-AUService Configuration
en-CAService Configuration
en-GBService Configuration
en-NZService Configuration
en-USService Configuration
it-CHConfigurazione servizio
it-ITConfigurazione servizio

Fields

Code (10)

Code[20]

The code.

LanguageCaption
de-ATCode
de-CHCode
de-DECode
en-AUCode
en-CACode
en-GBCode
en-NZCode
en-USCode
it-CHCodice
it-ITCodice

Type (15)

Enum "EOS004 Service Config. Type"

Specifies the type of service that this configuration is for.

LanguageCaption
de-ATArt
de-CHArt
de-DEArt
en-AUType
en-CAType
en-GBType
en-NZType
en-USType
it-CHTipo
it-ITTipo

Description (20)

Text[50]

Description.

LanguageCaption
de-ATBeschreibung
de-CHBeschreibung
de-DEBeschreibung
en-AUDescription
en-CADescription
en-GBDescription
en-NZDescription
en-USDescription
it-CHDescrizione
it-ITDescrizione

Endpoint Uri (30)

Text[1024]

The endpoint URI for this configuration. This may be optional, depending on the service type.

LanguageCaption
de-ATEndpunkt-URI
de-CHEndpunkt-URI
de-DEEndpunkt-URI
en-AUEndpoint Uri
en-CAEndpoint Uri
en-GBEndpoint Uri
en-NZEndpoint Uri
en-USEndpoint Uri
it-CHEndpoint Uri
it-ITEndpoint Uri

Configuration (40)

Blob

A Blob containing the service-specific configuration settings.

LanguageCaption
de-ATKonfiguration
de-CHKonfiguration
de-DEKonfiguration
en-AUConfiguration
en-CAConfiguration
en-GBConfiguration
en-NZConfiguration
en-USConfiguration
it-CHConfigurazione
it-ITConfigurazione

Logging (50)

Option

"None" (0) , "Failures Only" (1) , "All" (2)

Specifies the logging verbosity of requests made for this configuration.

LanguageCaption
de-ATLogging
de-CHLogging
de-DELogging
en-AULogging
en-CALogging
en-GBLogging
en-NZLogging
en-USLogging
it-CHLogging
it-ITLogging

Request Timeout (sec) (60)

Integer

Specifies the timeout in seconds for requests.

LanguageCaption
de-ATRequest Timeout (Sek)
de-CHRequest Timeout (Sek)
de-DERequest Timeout (Sek)
en-AURequest Timeout (sec)
en-CARequest Timeout (sec)
en-GBRequest Timeout (sec)
en-NZRequest Timeout (sec)
en-USRequest Timeout (sec)
it-CHRequest Timeout (sec)
it-ITRequest Timeout (sec)

Methods

GetSettingKeys

procedure GetSettingKeys(): List of [Text]

Retrieves all list of all setting keys present in the current configuration.

Parameters / Return Value

  • Returns List[Text]

    The list of currently configured keys.

IsSettingMasked

procedure IsSettingMasked(SettingKey: Text): Boolean

Checks if a given setting key was stored masked.

Parameters / Return Value

  • SettingKey Text[]

    The setting key.

  • Returns Boolean

    true if the setting exists and was stored masked. false otherwise.

GetSettingValue

procedure GetSettingValue(SettingKey: Text): Text

Reads the given setting from the configuration.

Parameters / Return Value

  • SettingKey Text[]

    The setting key to read.

  • Returns Text[]

    The setting value. If the setting was stored masked, a placeholder text is returned.

GetSettingValueAsSecret

procedure GetSettingValueAsSecret(SettingKey: Text; WithError: Boolean): SecretText

Reads the given setting from the configuration as a secret text.

Parameters / Return Value

  • SettingKey Text[]

    The setting key to read.

  • WithError Boolean

    If this is true, an error is raised should the setting not exist or have no value.

  • Returns SecretText

    The setting value as a secret text.

GetSettingValue

procedure GetSettingValue(SettingKey: Text; Unmask: Boolean; WithError: Boolean): Text

Reads the given setting from the configuration.

Parameters / Return Value

  • SettingKey Text[]

    The setting key to read.

  • Unmask Boolean

    This only applies to settings that have been stored masked and has no effect on settings that were stored unmasked. If this is true, the setting is unmasked after reading. If this is false a placeholder string is read instead.

  • WithError Boolean

    If this is true, an error is raised should the setting not exist or have no value.

  • Returns Text[]

    The setting value, or - if applicable - a placeholder text.

SetSettingValue

procedure SetSettingValue(SettingKey: Text; Masked: Boolean; SettingValue: Text)

Stores the given setting in the configuration. Any existing value will be overwritten.

Parameters / Return Value

  • SettingKey Text[]

    The setting key to store.

  • Masked Boolean

    Indicates if the setting should be stored masked. A masked setting is not immediately visible on the configuration.

  • SettingValue Text[]

    The setting value to store.


EOS Labs -