symphony.bdk.core.config.model.bdk_client_config.BdkClientConfig

class symphony.bdk.core.config.model.bdk_client_config.BdkClientConfig(parent_config, config)

Bases: symphony.bdk.core.config.model.bdk_server_config.BdkServerConfig

Class containing a client configuration: - scheme (e.g. ‘https’) - host - port - context (path to be appended after the port). This is used to build the URL when making HTTP calls. URL will be built as follows: {scheme}://{host}:{port}/{context}

__init__(parent_config, config)

Parameters

• parent_config – the parent configuration of type BdkConfig

• config – client configuration parameters of type dict

Methods

__init__(parent_config, config)	param parent_config the parent configuration of type BdkConfig
get_base_path()	Constructs the base path of the current config
get_formatted_context()	Formats the context field
get_port_as_string()	return the port information to be appended to the built URL

Attributes

DEFAULT_HTTPS_PORT
DEFAULT_SCHEME
context	Return the applicable context path: either the one configured at child level (e.g.
default_headers	Return the applicable default headers: either the one configured at child level (e.g.
host	Return the applicable host: either the one configured at child level (e.g.
port	Return the applicable port: either the one configured at child level (e.g.
proxy	Return the applicable proxy information: either the one configured at child level (e.g.
scheme	Return the applicable scheme: either the one configured at child level (e.g.

property context

Return the applicable context path: either the one configured at child level (e.g. ‘pod’) or at global level.

Returns

the applicable context path

property default_headers

Return the applicable default headers: either the one configured at child level (e.g. ‘pod’) or at global level.

Returns

the applicable default headers

get_base_path() → str

Constructs the base path of the current config

Returns

scheme://host:port + formatted_context

Return type

str

get_formatted_context() → str

Formats the context field

Returns

“/” + context if the context is not empty

Return type

str

get_port_as_string() → str

Returns

the port information to be appended to the built URL

property host

Return the applicable host: either the one configured at child level (e.g. ‘pod’) or at global level.

Returns

the applicable host (e.g. ‘acme.symphony.com’)

property port

Return the applicable port: either the one configured at child level (e.g. ‘pod’) or at global level.

Returns

the applicable port (e.g. 443)

property proxy

Return the applicable proxy information: either the one configured at child level (e.g. ‘pod’) or at global level.

Returns

the applicable proxy information

property scheme

Return the applicable scheme: either the one configured at child level (e.g. ‘pod’) or at global level.

Returns

the applicable scheme (e.g. ‘https’)