Base class for a TFX Beam pipeline component.
Inherits From: BaseComponent, BaseNode
tfx.v1.types.BaseBeamComponent(
spec: types.ComponentSpec,
custom_executor_spec: Optional[executor_spec.ExecutorSpec] = None
)
An instance of a subclass of BaseBaseComponent represents the parameters for a single execution of that TFX Beam pipeline component.
Beam based components should subclass BaseBeamComponent instead of BaseComponent in order to inherit Beam related SDKs. All subclasses of BaseBeamComponent should override the required class level attributes specified in BaseComponent.
Args | |
|---|---|
spec
|
types.ComponentSpec object for this component instance. |
custom_executor_spec
|
Optional custom executor spec overriding the default executor specified in the component attribute. |
Attributes | |
|---|---|
outputs
|
Component's output channel dict. |
Methods
with_beam_pipeline_args
with_beam_pipeline_args(
beam_pipeline_args: Iterable[Union[str, placeholder.Placeholder]]
) -> 'BaseBeamComponent'
Add per component Beam pipeline args.
| Args | |
|---|---|
beam_pipeline_args
|
List of Beam pipeline args to be added to the Beam executor spec. |
| Returns | |
|---|---|
| the same component itself. |
with_node_execution_options
with_node_execution_options(
node_execution_options: utils.NodeExecutionOptions
) -> typing_extensions.Self
Class Variables | |
|---|---|
| POST_EXECUTABLE_SPEC |
None
|
| PRE_EXECUTABLE_SPEC |
None
|