configuration
edgeimpulse_api v1.0.0
edgeimpulse_api.configuration module
class edgeimpulse_api.configuration.Configuration(host=None, api_key=None, api_key_prefix=None, username=None, password=None, access_token=None, server_index=None, server_variables=None, server_operation_index=None, server_operation_variables=None, ssl_ca_cert=None)Bases:
object
param host
Base url.
param api_key
Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret.
param api_key_prefix
Dict to store API prefix (e.g. Bearer). The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data.
param username
Username for HTTP basic authentication.
param password
Password for HTTP basic authentication.
param access_token
Access token.
param server_index
Index to servers configuration.
param server_variables
Mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.
param server_operation_index
Mapping from operation ID to an index to server configuration.
param server_operation_variables
Mapping from operation ID to a mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.
param ssl_ca_cert
str - the path to a file of concatenated CA certificates in PEM format.
Example
API Key Authentication Example. Given the following security scheme in the OpenAPI specification:
components:
securitySchemes:
cookieAuth: # name for the security scheme
type: apiKey in: cookie name: JSESSIONID # cookie name
You can programmatically set the cookie:
conf = edgeimpulse_api.Configuration(
api_key={‘cookieAuth’: ‘abc123’} api_key_prefix={‘cookieAuth’: ‘JSESSIONID’}
)
The following cookie will be added to the HTTP request:
Cookie: JSESSIONID abc123
access_token()Access token
assert_hostname()Set this to True/False to enable/disable SSL hostname verification.
auth_settings()Gets Auth Settings dict for api client.
Returns
The Auth Settings information dict.
cert_file()client certificate file
connection_pool_maxsize()urllib3 connection pool’s maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.
property debug()Debug switch
get_api_key_with_prefix(identifier, alias=None)Gets API key (with prefix if set).
Parameters
identifier – The identifier of apiKey.
alias – The alternative identifier of apiKey.
Returns
The token for api key authentication.
get_basic_auth_token()Gets HTTP basic authentication header (string).
Returns
The token for basic HTTP authentication.
classmethod get_default()Return the default configuration.
This method returns newly created, based on default constructor, object of Configuration class or returns a copy of default configuration.
Returns
The configuration object.
classmethod get_default_copy()Deprecated. Please use get_default instead.
Deprecated. Please use get_default instead.
Returns
The configuration object.
get_host_from_settings(index, variables=None, servers=None)Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value :param servers: an array of host settings or None :return: URL based on host settings
get_host_settings()Gets an array of host settings
Returns
An array of host settings
property host()Return generated host.
key_file()client key file
logger()Logging Settings
property logger_file()Debug file location
logger_file_handler()Log file handler
property logger_format()Log format
logger_stream_handler()Log stream handler
password()Password for HTTP basic authentication
proxy()Proxy URL
proxy_headers()Proxy headers
refresh_api_key_hook()function hook to refresh API key if expired
retries()Adding retries to override urllib3 default value 3
safe_chars_for_path_param()Safe chars for path_param
server_operation_index()Default server index
server_operation_variables()Default server variables
classmethod set_default(default)Set default instance of configuration.
It stores default configuration, which can be returned by get_default_copy method.
Parameters
default – object of Configuration
socket_options()Options to pass down to the underlying urllib3 socket
ssl_ca_cert()Set this to customize the certificate file to verify the peer.
temp_folder_path()Temp file folder for downloading files
to_debug_report()Gets the essential information for debugging.
Returns
The report for debugging.
username()Username for HTTP basic authentication
verify_ssl()SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.
Last updated
Was this helpful?