caikit.interfaces.common.data_model.remote

This file contains interfaces required to connect to Remote servers

Attributes

log
error

Classes

ConnectionTlsInfo	Helper dataclass to store information regarding TLS information.
ConnectionInfo	DataClass to store information regarding an external connection. This includes the hostname,

Module Contents

caikit.interfaces.common.data_model.remote.log

caikit.interfaces.common.data_model.remote.error

class caikit.interfaces.common.data_model.remote.ConnectionTlsInfo

Bases: caikit.core.data_model.DataObjectBase

Helper dataclass to store information regarding TLS information.

enabled: bool = False

insecure_verify: bool = False

ca_file: str | None

cert_file: str | None

key_file: str | None

property mtls_enabled: bool

Helper property to identify if mtls is enabled

_private_slots = ('_ca_data', '_cert_data', '_key_data')

property ca_data: bytes | None

property key_data: bytes | None

property cert_data: bytes | None

__post_init__()

Post init function to verify field types and arguments

verify_ssl_data()

Helper function to verify all TLS data was read correctly.

Raises:

FileNotFoundError: If any of the tls files were provided but could not be found

class caikit.interfaces.common.data_model.remote.ConnectionInfo

Bases: caikit.core.data_model.DataObjectBase

DataClass to store information regarding an external connection. This includes the hostname, port, tls, and timeout settings

hostname: str

port: int | None = None

tls: ConnectionTlsInfo | None

timeout: int | None = 60

options: caikit.core.data_model.json_dict.JsonDict | None

retries: int | None = 1

retry_options: caikit.core.data_model.json_dict.JsonDict | None

max_session_age: float | int = -1

__post_init__()

Post init function to verify field types and set defaults