OutputPort Class

Instance of an output port on a node, which can be connected to an input port.

Initialize OutputPort.

Inheritance

builtins.object

OutputPort

Constructor

OutputPort(node, output_port_def)

Parameters

node

Node

Required

Node which contains this output

output_port_def

OutputPortDef

Required

Definition of the module output port

node

Node

Required

Node which contains this output

output_port_def

OutputPortDef

Required

Definition of the module output port

Methods

connect

Connect this port to a source.

connect

Connect this port to a source.

connect(dest_port)

Parameters

dest_port

InputPort

Required

Input port from the node that is the destination of the connection.

Returns

The created edge.

Return type

Edge

Attributes

bind_mode

Get the mode for producing output, either "mount" or "upload"(local file which is uploaded) or "hdfs".

Returns

The datastore mode.

Return type

str

data_type

Get the type of the data.

Returns

_data_type

Return type

str

dataset_output

Get the output dataset configuration.

Returns

The output dataset configuration.

Return type

OutputDatasetConfig

dataset_registration

Get the dataset registration information.

Returns

The dataset registration information.

Return type

DatasetRegistration

datastore_name

Get the name of the datastore to write this output to.

Returns

The datastore name.

Return type

str

name

Get the name of the Output port.

Returns

The name.

Return type

str

node

Return the node where the Output port is part of.

Returns

node

Return type

Node

overwrite

For "upload" mode, indicate whether to overwrite existing data.

Returns

_overwrite

Return type

str

path_on_compute

For "upload" mode, the path to which the module writes this output during execution.

Returns

The path on compute.

Return type

str

pipeline_output_name

Get the name of the pipeline output corresponding to this OutputPort.

Returns

The pipeline output name.

Return type

str