Skip to content

Config

Configuration class for the StreamPipes client.

StreamPipesClientConfig dataclass

Configure the StreamPipes client in accordance to the actual StreamPipes instance to connect to.

An instance is provided to the StreamPipesClient to configure it properly.

PARAMETER DESCRIPTION
credential_provider

Provides the credentials to authenticate with the StreamPipes API.

TYPE: CredentialProvider

host_address

Host address of the StreamPipes instance to connect to. Should be provided without the protocol/scheme, e.g. as localhost or streampipes.xyz.

TYPE: str

https_disabled

Determines whether https is used to connect to StreamPipes.

TYPE: Optional[bool] DEFAULT: False

port

Specifies the port under which the StreamPipes API is available, e.g., 80 (with http) or 443 (with https)

TYPE: Optional[int] DEFAULT: 80

Examples:

see StreamPipesClient