Skip to content

config

Classes to configure connectors.

Warning

These classes should not be used directly. Instead define a ConnectorConfig class in the scope of the connector class with the fields set to the desired values. They are then validated and converted to these classes internally.

ConnectorConfig

Bases: BaseModel

Base configuration class for connectors.

Attributes:

Name Type Description
name str

Name of the connector. This will be displayed as a name of the template.
type str

Type of the connector. This will correspond to the type of the service task that will be calling the connector.
timeout Optional[int]

Timeout for the connector.
Source code in python_camunda_sdk/connectors/config.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
class ConnectorConfig(BaseModel):
    """Base configuration class for connectors.

    Attributes:
        name: Name of the connector. This will be displayed as a name
            of the template.
        type: Type of the connector. This will correspond to the type of
            the service task that will be calling the connector.
        timeout: Timeout for the connector.
    """

    name: str
    type: str
    timeout: Optional[int] = 10

OutboundConnectorConfig

Bases: ConnectorConfig

Outbound connector configuration.

Source code in python_camunda_sdk/connectors/config.py 
22
23
24
25
class OutboundConnectorConfig(ConnectorConfig):
    """Outbound connector configuration."""

    pass

InboundConnectorConfig

Bases: ConnectorConfig

Inbound connector configuration.

Source code in python_camunda_sdk/connectors/config.py 
28
29
30
31
class InboundConnectorConfig(ConnectorConfig):
    """Inbound connector configuration."""

    pass