argo.configuration¶
Argo
Argo # noqa: E501
The version of the OpenAPI document: v2.7.5 Generated by: https://openapi-generator.tech
Module Contents¶
-
class
argo.configuration.TypeWithDefault(cls, name, bases, dct)¶ Create and return a new object. See help(type) for accurate signature.
-
set_default(cls, default)¶
-
-
class
argo.configuration.Configuration(host='http://localhost:2746', api_key={}, api_key_prefix={}, username='', password='')¶ NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech Do not edit the class manually.
- Parameters
host – Base url
api_key – Dict to store API key(s)
api_key_prefix – Dict to store API prefix (e.g. Bearer)
username – Username for HTTP basic authentication
password – Password for HTTP basic authentication
Constructor
-
host¶ Default Base url
-
temp_folder_path¶ Temp file folder for downloading files
-
api_key¶ dict to store API key(s)
-
api_key_prefix¶ dict to store API prefix (e.g. Bearer)
-
refresh_api_key_hook¶ function hook to refresh API key if expired
-
username¶ Username for HTTP basic authentication
-
password¶ Password for HTTP basic authentication
-
logger¶ Logging Settings
-
logger_format= %(asctime)s %(levelname)s %(message)s¶ Log format
-
logger_stream_handler¶ Log stream handler
-
logger_file_handler¶ Log file handler
-
logger_file¶ Debug file location
-
debug= False¶ Debug switch
-
verify_ssl= True¶ SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.
-
ssl_ca_cert¶ Set this to customize the certificate file to verify the peer.
-
cert_file¶ client certificate file
-
key_file¶ client key file
-
assert_hostname¶ Set this to True/False to enable/disable SSL hostname verification.
-
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.
-
proxy¶ Proxy URL
-
proxy_headers¶ Proxy headers
-
safe_chars_for_path_param=¶ Safe chars for path_param
-
retries¶ Adding retries to override urllib3 default value 3
-
property
logger_file(self) The logger file.
If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.
- Parameters
value – The logger_file path.
- Type
str
-
property
debug(self) Debug status
- Parameters
value – The debug status, True or False.
- Type
bool
-
property
logger_format(self) The logger format.
The logger_formatter will be updated when sets logger_format.
- Parameters
value – The format string.
- Type
str
-
get_api_key_with_prefix(self, identifier)¶ Gets API key (with prefix if set).
- Parameters
identifier – The identifier of apiKey.
- Returns
The token for api key authentication.
-
get_basic_auth_token(self)¶ Gets HTTP basic authentication header (string).
- Returns
The token for basic HTTP authentication.
-
auth_settings(self)¶ Gets Auth Settings dict for api client.
- Returns
The Auth Settings information dict.
-
to_debug_report(self)¶ Gets the essential information for debugging.
- Returns
The report for debugging.
-
get_host_settings(self)¶ Gets an array of host settings
- Returns
An array of host settings
-
get_host_from_settings(self, index, variables={})¶ 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 :return: URL based on host settings