configuration ¶

OQTOPUS Cloud User API

OQTOPUS Cloud User API. This API is used to interact with the OQTOPUS Cloud service. The API provides endpoints to manage devices, jobs, and results.

The version of the OpenAPI document: 1.0 Contact: oqtopus-team[at]googlegroups.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Classes:

Configuration –

This class contains various settings of the API client.

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,
    ignore_operation_servers=False,
    ssl_ca_cert=None,
    retries=None,
    *,
    debug: Optional[bool] = None,
)

This class contains various settings of the API client.

:param host: Base url. :param ignore_operation_servers Boolean to ignore operation servers for the API client. Config will use host as the base url regardless of the operation servers. :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. :param retries: Number of retries for API requests.

:Example:

Methods:

auth_settings –

Gets Auth Settings dict for api client.
get_api_key_with_prefix –

Gets API key (with prefix if set).
get_basic_auth_token –

Gets HTTP basic authentication header (string).
get_default –

Return the default configuration.
get_default_copy –

Deprecated. Please use get_default instead.
get_host_from_settings –

Gets host URL based on the index and variables
get_host_settings –

Gets an array of host settings
set_default –

Set default instance of configuration.
to_debug_report –

Gets the essential information for debugging.

Attributes:

access_token –

Access token
assert_hostname –

Set this to True/False to enable/disable SSL hostname verification.
cert_file –

client certificate file
connection_pool_maxsize –

This value is passed to the aiohttp to limit simultaneous connections.
date_format –

date format
datetime_format –

datetime format
debug –

Debug status
host –

Return generated host.
ignore_operation_servers –

Ignore operation servers
key_file –

client key file
logger –

Logging Settings
logger_file –

The logger file.
logger_file_handler (Optional[FileHandler]) –

Log file handler
logger_format –

The logger format.
logger_stream_handler –

Log stream handler
password –

Password for HTTP basic authentication
proxy (Optional[str]) –

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
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
tls_server_name –

SSL/TLS Server Name Indication (SNI)
username –

Username for HTTP basic authentication
verify_ssl –

SSL/TLS verification

access_token `instance-attribute` ¶

access_token = access_token

Access token

assert_hostname `instance-attribute` ¶

assert_hostname = None

Set this to True/False to enable/disable SSL hostname verification.

cert_file `instance-attribute` ¶

cert_file = None

client certificate file

connection_pool_maxsize `instance-attribute` ¶

connection_pool_maxsize = 100

This value is passed to the aiohttp to limit simultaneous connections. Default values is 100, None means no-limit.

date_format `instance-attribute` ¶

date_format = '%Y-%m-%d'

date format

datetime_format `instance-attribute` ¶

datetime_format = '%Y-%m-%dT%H:%M:%S.%f%z'

datetime format

debug `property` `writable` ¶

debug

Debug status

:param value: The debug status, True or False. :type: bool

host `property` `writable` ¶

host

Return generated host.

ignore_operation_servers `instance-attribute` ¶

ignore_operation_servers = ignore_operation_servers

Ignore operation servers

key_file `instance-attribute` ¶

key_file = None

client key file

logger `instance-attribute` ¶

logger = {}

Logging Settings

logger_file `property` `writable` ¶

logger_file

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.

:param value: The logger_file path. :type: str

logger_file_handler `instance-attribute` ¶

logger_file_handler: Optional[FileHandler] = None

Log file handler

logger_format `property` `writable` ¶

logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

:param value: The format string. :type: str

logger_stream_handler `instance-attribute` ¶

logger_stream_handler = None

Log stream handler

password `instance-attribute` ¶

password = password

Password for HTTP basic authentication

proxy `instance-attribute` ¶

proxy: Optional[str] = None

Proxy URL

proxy_headers `instance-attribute` ¶

proxy_headers = None

Proxy headers

refresh_api_key_hook `instance-attribute` ¶

refresh_api_key_hook = None

function hook to refresh API key if expired

retries `instance-attribute` ¶

retries = retries

Adding retries to override urllib3 default value 3

safe_chars_for_path_param `instance-attribute` ¶

safe_chars_for_path_param = ''

Safe chars for path_param

server_operation_index `instance-attribute` ¶

server_operation_index = server_operation_index or {}

Default server index

server_operation_variables `instance-attribute` ¶

server_operation_variables = (
    server_operation_variables or {}
)

Default server variables

socket_options `instance-attribute` ¶

socket_options = None

Options to pass down to the underlying urllib3 socket

ssl_ca_cert `instance-attribute` ¶

ssl_ca_cert = ssl_ca_cert

Set this to customize the certificate file to verify the peer.

temp_folder_path `instance-attribute` ¶

temp_folder_path = None

Temp file folder for downloading files

tls_server_name `instance-attribute` ¶

tls_server_name = None

SSL/TLS Server Name Indication (SNI) Set this to the SNI value expected by the server.

username `instance-attribute` ¶

username = username

Username for HTTP basic authentication

verify_ssl `instance-attribute` ¶

verify_ssl = True

SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.

auth_settings ¶

auth_settings()

Gets Auth Settings dict for api client.

:return: The Auth Settings information dict.

get_api_key_with_prefix ¶

get_api_key_with_prefix(identifier, alias=None)

Gets API key (with prefix if set).

:param identifier: The identifier of apiKey. :param alias: The alternative identifier of apiKey. :return: The token for api key authentication.

get_basic_auth_token ¶

get_basic_auth_token()

Gets HTTP basic authentication header (string).

:return: The token for basic HTTP authentication.

get_default `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.

:return: The configuration object.

get_default_copy `classmethod` ¶

get_default_copy()

Deprecated. Please use get_default instead.

:return: The configuration object.

get_host_from_settings ¶

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 ¶

get_host_settings()

Gets an array of host settings

:return: An array of host settings

set_default `classmethod` ¶

set_default(default)

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

:param default: object of Configuration

to_debug_report ¶

to_debug_report()

Gets the essential information for debugging.

:return: The report for debugging.

configuration ¶

Configuration ¶

access_token instance-attribute ¶

assert_hostname instance-attribute ¶

cert_file instance-attribute ¶

connection_pool_maxsize instance-attribute ¶

date_format instance-attribute ¶

datetime_format instance-attribute ¶

debug property writable ¶

host property writable ¶

ignore_operation_servers instance-attribute ¶

key_file instance-attribute ¶

logger instance-attribute ¶

logger_file property writable ¶

logger_file_handler instance-attribute ¶

logger_format property writable ¶

logger_stream_handler instance-attribute ¶

password instance-attribute ¶

proxy instance-attribute ¶

proxy_headers instance-attribute ¶

refresh_api_key_hook instance-attribute ¶

retries instance-attribute ¶

safe_chars_for_path_param instance-attribute ¶

server_operation_index instance-attribute ¶

server_operation_variables instance-attribute ¶

socket_options instance-attribute ¶

ssl_ca_cert instance-attribute ¶

temp_folder_path instance-attribute ¶

tls_server_name instance-attribute ¶

username instance-attribute ¶

verify_ssl instance-attribute ¶