Skip to main content

ConnectorEnvironment

Configure a connector environment for custom Flyte connectors.

Attributes​

AttributeTypeDescription
typestr = connectorThe identifier for the environment type, defaulting to "connector" to specify a custom Flyte connector environment.
port`intPort` = Port(port=8080, name="h2c")

Constructor​

Signature​

def ConnectorEnvironment(
type: str = "connector",
port: int | Port = Port(port=8080, name="h2c")
) -> null

Parameters​

NameTypeDescription
typestr = "connector"The environment type identifier, defaults to 'connector'.
port`intPort` = Port(port=8080, name="h2c")

Methods​


container_args()​

def container_args(self, serialize_context: SerializationContext) -> List[str]: ...

Generates the command-line arguments for the connector container, including port configurations and the list of Python modules to load.

Parameters​

NameTypeDescription
serialize_contextSerializationContextThe context object containing settings and state for the current serialization pass.

Returns​

TypeDescription
List[str]A list of string arguments used to start the connector process, such as port flags and module names.

container_cmd()​

def container_cmd(
self, serialize_context: SerializationContext, parameter_overrides: list[Parameter] | None = None
) -> List[str]: ...

Determines the primary command to execute within the container, prioritizing explicit overrides before falling back to parent defaults.

Parameters​

NameTypeDescription
serialize_contextSerializationContextThe context object containing settings and state for the current serialization pass.
parameter_overrides`list[Parameter]None`

Returns​

TypeDescription
List[str]The executable command split into a list of strings suitable for container execution.